package research.simulation
Get desktop application:
View/edit binary Protocol Buffers messages
message
monitor.proto:45Used in:
optional string key = 1
The name of the analytics variable that will serve as an internal state key and as the dump filename prefix. It is highly recommended that the key's prefix conform to the following format: MONITOR_[ANALYTICS_TYPE]_[STATE_NAME] E.g. a reasonable name for the second moment of the vertical velocity is 'MONITOR_moment_w_variance'. Note that this convention is recommended for readability purposes only, and the only true requirement is that there be no collisions between this and any of the state names or any of the keys specified in `helper_var_keys`.
oneof spec
moment_statistic = 2
norm = 3
raw_state = 4
message
radiative_transfer.proto:43Used in:
optional float sfc_emis = 1
Surface emissivity; the same for all bands.
optional float sfc_alb = 2
Surface albedo; the same for all bands.
optional float zenith = 3
The solar zenith angle (in radians).
optional float irrad = 4
The total solar irradiance (in W/m²).
optional float toa_flux_lw = 5
The longwave incident flux at the top of the atmosphere (in W/m²).
optional string vmr_sounding_filepath = 6
Path of a csv file containing volume mixing ratio sounding for particular gas species on a uniform log scale pressure grid. One column should be labeled 'p_ref' for the corresponding pressure profile in Pa that will be used when interpolating to the simulation's pressure field. All other columns should be labeled with the chemical formula of the gas they correspond to. Note that the pressure grid under p_ref must be log-uniformly spaced to ensure accurate interpolation of the profiles.
optional string vmr_global_mean_filepath = 7
The path of a json file containing volume mixing ratio global means, indexed by the gas chemical formula. This should be populated by gas species that have little variability in the atmosphere. The contents of the file should be a dictionary in json format.
message
poisson_solver.proto:46Next id: 7
Used in:
repeated float coefficients = 1
optional int32 halo_width = 2
optional int32 dominating_direction = 3
optional float dominating_grid_spacing_gap = 4
optional int32 taylor_expansion_order = 5
One might do Taylor expansion to any order, for the preconditioner matrix sum's inverse: (1 + x)^{-1} = 1 - x + x^2 - x^3 + ...
optional bool symmetric = 6
When there is no Taylor expansion, fall back to the symmetric version, or apply the operator in the donimating direction only.
message
biofuel_multistep.proto:28Parameters for the multistep biofuel combustion model. Next id: 3
Used in:
optional dehydration = 1
optional pyrolysis_char_oxidation = 2
message
boundary_conditions.proto:25Stores the boundary conditions of a variable for the 6 faces of the computational domain.
Used in:
optional string name = 1
The name of the variable for which the boundary conditions belongs to.
repeated boundary_info = 2
The detailed information of each boundary.
message
boundary_conditions.proto:29Used in:
optional int32 buffer_init_step = 1
This controls the step_id when the buffer storing the boundary condition value is initialized to a desired value. The specific initialization will depend on the type of the boundary condition. Currently this is only used for NONREFLECTING boundary type.
optional BoundaryConditionParams.NonReflectingMode nonreflecting_bc_mode = 2
This only applies for NONREFLECTING boundary condition type. It controls how the phase velocity in the convective nonreflecting boundary condition is determined. Specifically, ∂ϕ/∂t = - U* ∂ϕ/∂x, for the "high" side of the domain, and ∂ϕ/∂t = + U* ∂ϕ/∂x, for the "low" side of the domain, and for NONREFLECTING_LOCAL_MAX, the phase velocity is calculated on the boundary as local point-wise max: U* = abs(max(u + u0, 0)), for the "high" end, and U* = abs(min(u - u0, 0)), for the "low" end. For NONREFLECTING_GLOBAL_MEAN: U* = abs(global_mean(u) + u0), for the "high" end, and U* = abs(global_mean(u) - u0), for the "low" end. where `mean` is the global mean over the entire boundary. For NONREFLECTING_GLOBAL_MAX: U* = abs(max(global_max(u), 0) + u0), for the "high" end, and U* = abs(min(global_min(u), 0) - u0), for the "low" end. Note that `u0` is specified as the value in BoundaryInfo.
Used in:
NONREFLECTING_LOCAL_MAX = 0
NONREFLECTING_GLOBAL_MEAN = 1
NONREFLECTING_GLOBAL_MAX = 2
message
boundary_conditions.proto:73The information of a boundary condition for a specific face. Next id: 6.
Used in:
optional int32 dim = 1
The dimension of the boundary condition.
optional int32 location = 2
The location of the boundary: 1 indicates the `high` end, and 0 indicates the low end.
optional swirl_lm.BoundaryConditionType type = 3
The type of the boundary condition.
optional float value = 4
The value associated with this boundary if `type` is `DIRICHLET`. TODO(wqing): make the value a 2D/3D array so that it can represent more complex boundary conditions.
optional bc_params = 5
Parameters associated with the specific boundary condition.
message
boundary_models.proto:28Stores parameters required by boundary models. Next id: 5
Used in:
optional ib = 1
Parameters required by the immersed boundary method.
optional most = 2
Parameters required by the Monin-Obukhov Similarity Theory.
repeated sponge = 3
Parameters required by the Rayleigh damping layer (a.k.a sponge layer).
optional simulated_inflow = 4
Parameters required by the simulated turbulent inflow library.
Parameters required by the Cartesian grid method. With this method, for variables with Dirichlet boundary condition, a mirror-flow approach is applied; and for those with Neumann boundary conditions, the values at the boundary is updated by taking average across all neighboring fluid nodes.
Used in:
repeated variables = 1
Variables for which the Cartesian grid method is applied.
message
combustion.proto:25A library for combustion models. Each model is represented as a separate field to allow using a combination of models in one simulation. Next id: 3
Used in:
optional wood = 1
The wood combustion model.
optional biofuel_multistep = 2
The biofuel combustion model.
message
poisson_solver.proto:37When evaluating convergence, one can use componentwise or elementwise difference as a criterion. Given two vectors `lhs`, `rhs`: 1. Compute `tol = atol + rtol * abs(rhs)` 2. Compute `diff = lhs - rhs` 3. Define `distance = max(abs(diff) - tol)` This is based on `rtol` applied to `rhs` only. If `symmetric` is set, one will compute the distance similarly and final distance is the maximum. Note that this criterion is close to `L_INF` norm, but not exact, and they're different in 2 ways: 1. residual = abs(diff) - tol, without an `abs` for `residual` 2. Based on #1, the distance could be negative when `lhs` & `rhs` are close enough. Next id: 4
Used in:
optional bool symmetric = 1
optional float atol = 2
Absolute tolerance, dominant for small values close to `0`.
optional float rtol = 3
Relative tolerance, dominant for large values far away from `0`.
message
thermodynamics.proto:81Parameters required by the constant density model.
Used in:
(message has no fields)
message
turbulent_combustion.proto:21The Thickened Flame model with constant coefficients. Next id: 2
Used in:
optional float thickening_factor = 1
Defines the flame thickening factor. This factor is the multiplier to the diffusivity, and the divisor to the reaction source term.
Defines the types of convection schemes. Next id: 10
Used in: ,
CONVECTION_SCHEME_UNKNOWN = 0
The default option where no scheme is used. Should results in an error.
CONVECTION_SCHEME_UPWIND_1 = 1
The first order upwinding scheme.
CONVECTION_SCHEME_QUICK = 2
The second order upwinding QUICK scheme.
CONVECTION_SCHEME_WENO_5 = 5
The fifth order WENO scheme.
CONVECTION_SCHEME_WENO_3 = 6
The third order WENO scheme.
CONVECTION_SCHEME_WENO_3_NN = 7
The third order WENO scheme based on pre-trained neural network.
CONVECTION_SCHEME_CENTRAL_2 = 3
The second order central differencing shceme.
CONVECTION_SCHEME_CENTRAL_4 = 4
The fourth order central differencing shceme.
CONVECTION_SCHEME_FLUX_LIMITER_VAN_LEER = 8
The Van Leer flux limiter.
CONVECTION_SCHEME_FLUX_LIMITER_MUSCL = 9
The MUSCL scheme.
message
biofuel_multistep.proto:9Parameters that are required to compute the dehydration source term. Next id: 4
Used in:
optional float activation_temperature = 1
The activation temperature of the dehydration process.
optional float arrhenius_factor = 2
The Arrhenius constant for the dehydration rate.
optional float min_dehydration_temperature = 3
The minimum temperature that the dehydration process starts. Default is set to 0 to allow the dehydration process to start at any temperature.
Defines the types of diffusion schemes.
Used in:
DIFFUSION_SCHEME_UNKNOWN = 0
The default option where no scheme is used. Should results in an error.
DIFFUSION_SCHEME_CENTRAL_5 = 1
The diffusion term computed with the second order central scheme at nodes. The width of the stencil is 5.
DIFFUSION_SCHEME_CENTRAL_3 = 2
The diffusion term computed from diffusive fluxes on cell faces. The width of the stencil is 3.
DIFFUSION_SCHEME_STENCIL_3 = 3
The diffusion term computed with a 27-node stencil (3 in each direction) without interpolations.
Parameters required by the direct forcing (with 1D interpolation) method. With this method, a force term is applied at the interface between the solid and fluid for all variables listed, which replaces the original right hand side function for these variables. Values inside the solid body remain untouched. Note that, to use this method, the user needs to provide a tensor that stores the correct interpolation weights of the immersed boundary.
Used in:
repeated variables = 1
Variables for which the direct forcing method is applied.
optional int32 dim = 2
The dimension along which the immersed boundary is cutting through and interpolated. Should be one of 0, 1, and 2.
Parameters required by the direct forcing method. With this method, a Rayleigh damping force is applied inside the solid for all variables listed, which overrides the original equation right hand side function.
Used in:
repeated variables = 1
Variables for which the Rayleigh damping method is applied.
optional float damping_coeff = 2
The value of the damping coefficient.
Parameters required by the feedback force (with 1D interpolation) method. With this method, a force term with constant damping coefficient is applied at the interface between the solid and fluid for all variables listed. Values inside the solid body remain untouched. Note that, to use this method, the user needs to provide a tensor that stores the correct interpolation weights of the immersed boundary.
Used in:
repeated variables = 1
Variables for which the feedback force method is applied.
optional int32 dim = 2
The dimension along which the immersed boundary is cutting through and interpolated. Should be one of 0, 1, and 2.
optional float damping_coeff = 3
The value of the damping coefficient.
message
scalars.proto:106Defines configurations for a generic scalar.
Used in:
(message has no fields)
message
radiative_transfer.proto:20Used in:
optional float p0 = 1
Reference surface pressure.
optional float alpha = 2
The ratio of the pressure scale height to the partial-pressure scale height of the infrared absorber.
optional float d0_lw = 3
Longwave optical depth of the entire gray atmosphere.
optional float d0_sw = 4
Shortwave optical depth of the entire gray atmosphere.
message
scalars.proto:120Defines configurations for total humidity. Next id: 7
Used in:
optional bool include_subsidence = 1
An option of whether the effect of subsidence velocity is included in the total humidity equation.
Information of a variable that's required to update its value in the immersed boundary.
Used in: , , , , ,
optional string name = 1
The name of the variable. Next id: 6
optional float value = 2
The reference value of this variable. This value is used as the target value inside the solid body. Currently only a single value is allowed inside the body. Cases that have multiple values inside the solid will be handled externally.
optional IBVariableInfo.BoundaryConditionType bc = 3
The type of boundary condition to be applied at the solid-fluid interface.
optional bool override = 4
An indicator of whether generated IB field overrides the original value. If `false`, the newly computed value will be added to the existing field with the same key.
optional float damping_coeff = 5
The value of the damping coefficient. This damping coefficient will override the global damping coefficient, and will be applied to this specific variable only. This coefficient is only used in the `sponge` and direct forcing methods. Note that this parameter is not affected by the `override` option provided above.
Types of boundary conditions to be applied at the solid-fluid interface. Next id: 4
Used in:
DIRICHLET = 1
NEUMANN = 2
NEUMANN_Z = 3
Neuamnn BC in the z direction. This can only be applied when there's only 1 fluid-solid interface in the z direction.
message
thermodynamics.proto:54Parameters required by the ideal gas law. Next id: 6
Used in:
optional float t_s = 1
The surface temperature, K. The default value is provided in the CLIMA design doc.
optional float height = 2
The height of the domain, in units of meter. Default value roughly represents of Earth’s midlatitude atmosphere.
optional float delta_t = 3
The temperature difference between the top and bottom of the domain, in units of K. Default value roughly represents of Earth’s midlatitude atmosphere.
optional float const_theta = 4
An indicator of whether constant potential temperature is used to define the reference/hydrostatic pressure. Do not define this field if the potential temperature in the simulation setup is not a constant.
optional float cv_d = 5
Isochoric specific heats of the dry air, J/kg/K. Sources for values below: 1. Pressel, Kyle G., Colleen M. Kaul, Tapio Schneider, Zhihong Tan, and Siddhartha Mishra. 2015. “Large-Eddy Simulation in an Anelastic Framework with Closed Water and Entropy Balances: LARGE-EDDY SIMULATION FRAMEWORK.” Journal of Advances in Modeling Earth Systems 7 (3): 1425–56. 2. https://www.engineeringtoolbox.com/water-properties-d_1508.html.
Parameters required by the immersed boundary method. Next id: 7
Used in:
oneof type
cartesian_grid = 1
mac = 2
sponge = 3
direct_forcing = 4
direct_forcing_1d_interp = 6
feedback_force_1d_interp = 5
message
microphysics.proto:21Parameters required by the Kessler microphysics. The full implementation of the model is in microphysics_kw1978.
Used in:
(message has no fields)
message
lpt.proto:9A library for Lagrangian Particle Tracking (LPT) simulations. Next id: 9
Used in:
optional float c_d = 1
The particle drag coefficient.
optional float tau_p = 2
The particle relaxation time.
optional float mass_threshold = 3
The threshold mass below which the particle is considered to be vanished.
optional int32 n_max = 4
The maximum number of particles that a replica can have.
repeated injector = 7
The regions where particles can be injected.
oneof lpt_parallel_approach
How the particles are stored in multi-TPU simulations.
field_exchange = 6
message
lpt.proto:91The approach where particles remain stored on their original TPU, regardless of where they are located in the domain, and field data is requested from the TPUs containing the particle locations to solve the equations of motion of the particles.
Used in:
optional FieldExchange.CommunicationMode communication_mode = 5
The approach to communicate fluid data between TPUs. Both approaches were determined to be approximately equal in performance.
Used in:
UNSPECIFIED = 0
The communication mode is unspecified. This is an error.
PAIRWISE = 1
The approach where each replica is assigned a destination replica, and the destination replica is assigned the present replica. The present replica sends the locations of particles located on the destination replica to the destination replica. The destination replica then interpolates the relevant fluid data at these locations and sends them back to the present replica. The present replica, simultaneously, does the same for the destination replica. This process is repeated `n` times for `n` total replicas. After `n` iterations, each replica will have communicated with every other replica, including itself.
ONE_SHUFFLE = 2
The approach where the replicas are arranged in a circle, and each replica sends data to the next replica in the circle and receives data from the previous replica in the circle. Every iteration, each replica interpolates the incoming particle locations that are physically located within that replicas domain, and inserts the data into the circulating data. After this process is repeated `n` times, the data will have returned to the original replica, and each replica will have the fluid data for all of its particle locations.
message
lpt.proto:20A three dimensional method to inject particles into the field.
Used in:
optional string name = 1
The name of the injector region.
optional int32 seed = 8
Random number generation seed.
optional injection_schedule = 2
Parameters that specify what timestep(s) to inject particles.
optional attributes = 3
The attributes (e.g., velocities and masses) to assign new particles.
oneof injector_type
The type of injector region used including different shapes or otherwise.
box = 4
A box where particles can be injected.
message
lpt.proto:28A box where particles are injected.
Used in:
optional min_pt = 1
The minimum point of the box.
optional max_pt = 2
The maximum point of the box.
message
lpt.proto:35Used in:
optional int32 initial_injection_step = 1
The time step to first inject particles (e.g., 0 for the first step).
optional int32 period = 2
An optional periodic injection schedule to begin after the first injection. If this is undefined, the injector is only called once at `initial_injection_step`. If this is defined, the injector is called every `period` steps after the `initial_injection_step`.
message
lpt.proto:21Used in: ,
optional float x = 1
optional float y = 2
optional float z = 3
message
lpt.proto:47The injected particle attributes. Here, you can either define particles completely randomly, or using prescribed velocities.
Used in:
optional int32 n_particles = 1
Number of particles to initialize in total upon each call to the injector.
optional velocity = 2
An optional field of u, v, w components for the velocities of the particles. If undefined, the particle directions, polar and azimuthal, are initialized randomly across the unit sphere and velocity magnitudes are uniformly distributed between 0 and `speed_max`.
optional float mass = 3
The mass of each particle. If undefined, the mass is set to an infinitesimal rigid particle.
optional float speed_max = 4
The maximum random velocity magnitudes for the particles. Particle velocity magnitudes are uniformly distributed between 0 and this value.
message
thermodynamics.proto:50Parameters required by the linear mixing model.
Used in:
(message has no fields)
Parameters required by the marker-and-cell (MAC) method. With this method, for variables with Dirichlet boundary condition, the prescribed value is assgined directly at the solid-fluid interface; for those with Neumann boundary conditions, values at the boundary is updated by taking values from the node right above it in the z direction.
Used in:
repeated variables = 1
Variables for which the marker-and-cell method is applied.
message
parameters.proto:216Stores parameters for the microphysics model.
Used in:
optional bool include_precipitation = 1
An option for including the effects of precipitation in the equations of humidity and possibly the energy variable.
optional bool include_condensation = 2
An option for including the effects of condensation in the equations for humidity. Note that this option is only valid when using q_c, q_v, and theta as the thermodynamic variables.
optional bool include_sedimentation = 3
An option for including sedimentation in the convective flux of the humidity variable.
oneof model_type
Specifies the option of microphysics model.
kessler = 4
one_moment = 5
message
monitor.proto:33The specification of a moment statistic. The k-th order moment of a state f is defined as E[(f - E[f])^k], where the expected value operator is over the homogeneous dimensions of the grid.
Used in:
optional int32 order = 1
optional string second_state = 2
Provide the name of a second state to obtain the cross moment of the two variables. This is useful when computing fluxes.
Parameters required by the Monin-Obukhov Similarity Theory. Next id = 20;
Used in:
optional float z_0 = 1
The roughness length, in units of m.
optional float z_t = 2
The heat roughness thickness, in units of m.
optional float u_star = 3
The friction velocity, in units of m/s.
optional float heat_flux = 4
The The heat flux from the ground to the surface air, in units of J/m^2.
optional float t_0 = 5
The reference temeprature, in units of K.
optional float beta_m = 6
The stability correction coefficient for momentum.
optional float beta_h = 7
The stability correction coefficient for heat.
optional float alpha = 8
An empirical constant with a value 0.74–1.0.
optional float t_s = 9
The surface temperature, in units of K.
optional float gamma_m = 10
An empirical coefficient used in the formulation of the momentum stability function for unstable boundary layer. Default value is taken from Stoll, Rob, and Fernando Porté-Agel. 2006. “Dynamic Subgrid-Scale Models for Momentum and Scalar Fluxes in Large-Eddy Simulations of Neutrally Stratified Atmospheric Boundary Layers over Heterogeneous Terrain.” Water Resources Research 42 (1): 2121.
optional float gamma_h = 11
An empirical coefficient used in the formulation of the energy stability function for unstable boundary layer. Default value is taken from Stoll, Rob, and Fernando Porté-Agel. 2006. “Dynamic Subgrid-Scale Models for Momentum and Scalar Fluxes in Large-Eddy Simulations of Neutrally Stratified Atmospheric Boundary Layers over Heterogeneous Terrain.” Water Resources Research 42 (1): 2121.
optional bool enable_theta_reg = 12
An option of whether to apply regularization to the potential temperature when evaluating the model closrue. If `true`, the potential temperature will be capped by an upper bound that is defined by `theta_max`.
optional float theta_max = 13
The maximum potential temperature for the model evaluation.
optional float theta_min = 14
The minimum potential temperature for the model evaluation.
repeated sea_level_ref = 15
Specifies the reference value at the sea surface level.
repeated exchange_coeff = 17
Specifies the exchange coefficient (if applicable) of scalars or momentum. If this field is provided, the exchange/drag coefficient for this particular variable will override the one computed from MOST.
repeated string active_scalar = 16
Specifies scalars to which MOST is applied.
optional bool debug = 18
An option for printing debuging information in log. To activate the debug prints, the following flag is required: swirl_debug_log_level=INFO.
optional float surface_gustiness = 19
Gustiness parameter, used as the minimum value for the surface wind speed when computing surface fluxes, in units of m/s. See, e.g., Wing et al. (2018), Radiative-convective equilibrium model intercomparison project.
Defines a generic type for a reference value in the MOST model. Next id: 3
Used in:
optional string name = 1
The name of the variable.
optional float value = 2
The reference value of this variable.
message
monitor.proto:84The specification of analytics quantities to be tracked by the analytics monitor. Note that every AnalyticsSpec will contribute an additional state to the simulation that will be dumped along with the other states.
Used in:
repeated state_analytics = 1
A list of analytics requests, one for each state.
optional time_averaging = 2
Time averaging specification. This is most useful for simulations that are supposed to reach a steady statistical state (i.e. time can be treated as a homogeneous dimension). It is also useful for eliminating the often noisy spinup phase from the analytics computation.
message
monitor.proto:20The specification of a norm.
Used in:
optional NormSpec.NormType norm_type = 1
Used in:
UNKNOWN = 0
L1 = 1
L2 = 2
L_INF = 3
Defines the types of numerical fluxes.
Used in:
NUMERICAL_FLUX_UNKNOWN = 0
The default option where no flux is used. Should results in an error.
NUMERICAL_FLUX_UPWINDING = 1
The upwinding flux.
NUMERICAL_FLUX_LF = 2
The Lax-Friedrich flux.
NUMERICAL_FLUX_ROE = 3
The Roe flux.
message
microphysics.proto:25Parameters required by the one-moment microphysics. The full implementation of the model is in microphysics_one_moment.
Used in:
optional float humidity_source_term_limiter_k = 1
Humidity source is clipped such that q + source * dt >= humidity_source_term_limiter_k * q.
optional rain = 2
Rain related parameters and calibration coefficients.
optional snow = 3
Snow related parameters and calibration coefficients.
optional ice = 4
Ice related parameters.
optional autoconversion = 5
Autoconversion related parameters.
optional accretion = 6
Accretion related parameters.
optional OneMoment.TerminalVelocityModelType terminal_velocity_model_type = 7
Terminal velocity parameterization options.
optional float temperature_max = 8
The cut-off temperature for the microphysics source terms. Temperatures above this value will be treated as this value. Density will be adjusted accordingly to conform with the equation of state.
message
microphysics.proto:121Constant coefficients in accretion.
Used in:
optional float e_lr = 1
Collision efficiency between rain drops and cloud droplets.
optional float e_ls = 2
Collision efficiency between snow and cloud droplets.
optional float e_ir = 3
Collision efficiency between rain drops and cloud ice.
optional float e_is = 4
Collision efficiency between snow and cloud ice.
optional float e_rs = 5
Collision efficiency between rain drops and cloud ice.
message
microphysics.proto:107Constant coefficients in autoconversion.
Used in:
optional float tau_lr = 1
Timescale for cloud liquid to rain water autoconversion [s].
optional float tau_is = 2
Timescale for cloud ice to snow autoconversion [s].
optional float q_l_threshold = 3
Threshold for cloud liquid to rain water autoconversion [kg/kg].
optional float q_i_threshold = 4
Threshold for cloud ice to snow autoconversion [kg/kg].
optional float r_is = 5
Threshold particle radius between ice and snow [m].
message
microphysics.proto:92Constants for ice related quantities.
Used in:
optional float rho = 1
The density of an ice crystal [kg/m^3].
optional float r_0 = 2
Typical ice crystal radius [m].
optional float m_e = 3
Exponent to the radius ratio in the mass equation.
optional float chi_m = 4
The calibration coefficients in the mass equation.
optional float del_m = 5
optional float n_0 = 6
The `n_0` parameter in the Marshall-Palmer distribution.
message
microphysics.proto:31Constants for rain related quantities.
Used in:
optional float rho = 1
The density of a rain drop [kg/m^3].
optional float c_d = 2
The drag coefficient of a rain drop.
optional float r_0 = 3
Typical rain drop radius [m].
optional float m_e = 4
Exponent to the radius ratio in the mass equation.
optional float chi_m = 5
The calibration coefficients in the mass equation.
optional float del_m = 6
optional float a_e = 7
Exponent to the radius ratio in the cross section area equation.
optional float chi_a = 8
The calibration coefficients in the cross section area equation.
optional float del_a = 9
optional float v_e = 10
optional float chi_v = 11
The calibration coefficients in the terminal velocity equation.
optional float del_v = 12
optional float a_vent = 13
The ventilation factor coefficients.
optional float b_vent = 14
optional float n_0 = 15
The `n_0` parameter in the Marshall-Palmer distribution.
message
microphysics.proto:60Constants for snow related quantities.
Used in:
optional float rho = 1
The apparent density of a falling snow crystal for calculating the terminal velocity [kg/m^3]. This is defined as the mass of the snow particle divided by the volume of circumscribing spheroid, and its value can range from 50 to 900 kg/m^3. In the atmosphere a typical value is around 100 kg/m^3.
optional float r_0 = 2
Typical snow crystal radius [m].
optional float m_e = 3
Exponent to the radius ratio in the mass equation.
optional float chi_m = 4
The calibration coefficients in the mass equation.
optional float del_m = 5
optional float a_e = 6
Exponent to the radius ratio in the cross section area equation.
optional float chi_a = 7
The calibration coefficients in the cross section area equation.
optional float del_a = 8
optional float v_e = 9
Exponent to the radius ratio in the terminal velocity equation.
optional float chi_v = 10
The calibration coefficients in the terminal velocity equation.
optional float del_v = 11
optional float nu = 12
The snow size distribution parameter exponent.
optional float a_vent = 13
The ventilation factor coefficients.
optional float b_vent = 14
Defines the type of terminal velocity parameterization.
Used in:
TERMINAL_VELOCITY_UNKNOWN = 0
An unimplemented terminal velocity.
TERMINAL_VELOCITY_POWER_LAW = 1
Terminal velocity parameterization using power-law distribution.
TERMINAL_VELOCITY_GAMMA_TYPE = 2
Terminal velocity parameterization using gamma function distribution per Chen et al. (2022).
message
radiative_transfer.proto:32Used in:
oneof optics_scheme
rrtm_optics = 1
gray_atmosphere_optics = 2
optional int32 face_interp_scheme_order = 3
Order of accuracy of face value reconstruction for interpolating pressure or temperature at grid cell boundaries. At least 3-rd order is recommended.
message
poisson_solver.proto:76A message that stores the parameters required by the selected Poisson solver. Next id: 5
Used in:
oneof solver
A solver that has exactly one type. New solvers can be added to this field.
jacobi = 1
fast_diagonalization = 2
conjugate_gradient = 3
multigrid = 4
message
poisson_solver.proto:107The parameters used by the conjugate gradient solver. Next id: 8
Used in:
optional int32 max_iterations = 1
The maximum number of iterations to be performed before the solution converges.
optional int32 halo_width = 2
The width of the halo cells.
optional float atol = 3
There could be multiple metrics to be used as convergence criterion: 1. L2 norm, absolute or relative to rhs 2. Componentwise difference, close to L_INF but not exactly the same. - For more details, refer to `ComponentWiseConvergence` definition. When both are specified, the final convergence criterion is a logical OR of these 2 conditions. Convergence criterion #1: L2 norm The absolute tolerance as a metric of the solution convergence.
optional bool l2_norm_reduction = 5
Orthogonal to `atol`, on the `L2` norm as the convergence criterion: - true: `L2` reduction relative to `rhs` - false: Absolute `L2`
optional component_wise_convergence = 6
Convergence criterion #2: componentwise, close to L_INF though not exact.
optional bool reprojection = 4
If true, subtracting off the mean of residual and iterate.
optional preconditioner = 7
message
poisson_solver.proto:91The parameters used by the fast diagonalization/direct solver. Next id: 6
Used in:
optional int32 halo_width = 1
The width of the halo cells.
optional float cutoff = 2
The threshold for the eigenvalues to prevent division by zero.
optional boundary_condition_low = 4
Boundary conditions of the lower end of a domain in each dimension.
optional boundary_condition_high = 5
Boundary conditions of the higher end of a domain in each dimension.
message
poisson_solver.proto:79The parameters used by the Jacobi iterative solver. Next id: 4
Used in:
optional int32 max_iterations = 1
The maximum number of iterations to be performed before the solution converges.
optional int32 halo_width = 2
The width of the halo cells.
optional float omega = 3
The weight to be applied to the update in each iteration.
message
poisson_solver.proto:142Next id: 8
Used in:
optional int32 num_iterations = 1
The number of multigrid cycle iterations.
optional int32 n_smooth = 2
The number of smoother iterations.
optional float weight = 3
The weight in the smoother. The default smoother is Jacobi, and the default value for the weight, 2/3, results in the standard weighted Jacobi.
optional int32 n_coarse = 4
The number of coarse grid correction iterations. Use 1 for V-cycle.
optional coarsest_subgrid_shape = 5
The coarsest subgrid shape.
optional bool use_a_inv = 6
Controls whether A-inverse is used. If false, smoothing is done at the coarsest level, rather than solving exactly.
optional boundary_condition = 7
A specification of boundary condition types per dimension.
message
scalars.proto:128Defines configurations for the liquid-ice potential temperature. Next id: 7
Used in:
optional bool include_radiation = 1
An option of whether radiation is included in the liquid-ice potential temperature equation.
optional bool include_subsidence = 2
An option of whether the effect of subsidence velocity is included in the liquid-ice potential temperature equation.
message
parameters.proto:80Options for performing pre- and post-process in the simulation. Next id: 4
Used in:
oneof pre_post_process_option
from_flags = 1
from_config = 2
from_flow_through_time = 3
message
parameters.proto:86Initializes pre- and post-process options from the config file. Next id: 7
Used in:
optional bool apply_preprocess = 1
optional int32 preprocess_step_id = 2
optional bool preprocess_periodic = 3
optional bool apply_postprocess = 4
optional int32 postprocess_step_id = 5
optional bool postprocess_periodic = 6
message
parameters.proto:82Initializes pre- and post-process options from command line flags.
Used in:
(message has no fields)
message
parameters.proto:101Initializes pre- and post-process options from flow through time. Note that this option is only valid if the face with index `inflow_face along the `mean_flow_dim` is associated with an inflow boundary type. The pre- and post-process step id will be rounded to the closest integer multiple of `num_steps`. Next id: 9
Used in:
optional bool apply_preprocess = 1
optional bool preprocess_periodic = 2
optional bool apply_postprocess = 3
optional bool postprocess_periodic = 4
optional int32 mean_flow_dim = 5
The dimension along with the flow through time is computed. Must be one of 0, 1, and 2.
optional int32 inflow_face = 6
The face from which the inflow is going into the domain. 0 for the lower index end, and 1 for the higher index end.
optional float preprocess_flow_through_time = 7
The flow through time at which pre-process is applied.
optional float postprocess_flow_through_time = 8
The flow through time at which post-process is applied.
message
poisson_solver.proto:68Conjugate gradient solver's preconditioner, to speed up convergence. Although Jacobi could be a good choice of precondition for e.g. diagonal dominant matrices, it does **NOT** apply for the Hessian matrix in Poisson solver, as its diagonal elements are all the same, and it doesn't help with convergence rate at all. Next id: 2
Used in:
oneof solver
band_preconditioner = 1
message
pressure.proto:23A library of parameters for solving the pressure equation. Next id: 7
Used in:
optional solver = 1
The option and parameters of the Poisson solver.
optional int32 num_d_rho_filter = 2
The number of filter operations to be applied to dϱ / dt on the right hand side of the Poisson equation for pressure correction. The default values is from reference: Charles D. Pierce and Parviz Moin, Progress-variable approach for large-eddy simulation of turbulent combustion. California, USA: Stanford University, 2001.
optional float d_rho_rtol = 3
A threshold for the rate change of density, i.e. the d rho / dt term, on the right hand side of the pressure Poisson equation. If the relative density change magnitude is smaller than `d_rho_rtol`, it's considered as 0.
optional bool pressure_outlet = 4
An option for making OUTFLOW (homogenoeus Neuamnn boundary condition for all velocity components) a pressure outlet. If this option is `true`, a homogeneous Dirichlet boundary condition will be enforced for pressure and its correction when an OUTLET boundary condition is detected. Default set to `false` for backward compatibility.
optional bool update_p_bc_by_flow = 5
An option for updating the pressure boundary condition based on the latest flow field and its boundary condition. If this option is `true`, the user specified boundary condition in the config file will be overwritten by the derived quantities based on the momentum equation, i.e. dp/dn = -convection + diffusion, where n is the direction normal to a boundary. If this option is `false`, it will follow the boundary condition specified in the config. Note that `pressure_outlet` option is not used if the option of this parameter is `false`. Default set to `true` for backward compatibility.
optional Pressure.VerticalBCTreatment vertical_bc_treatment = 6
An option for the treatment of the pressure boundary condition at a wall in the presence of gravity.
Used in:
APPROXIMATE = 0
Original implementation where pressure and buoyancy at the wall only approximately balance. This is currently left as the default option so as not to break existing simulations. New simulations should prefer the option PRESSURE_BUOYANCY_BALANCING. Eventually, this option will be removed.
PRESSURE_BUOYANCY_BALANCING = 1
Option where the BC is computed precisely to ensure balance of the pressure and buoyancy force at the wall, to avoid spurious forcing of a fluid from equilibrium.
message
probe.proto:23Defines parameters that initializes probes. Next id: 5
Used in:
repeated location = 1
The physical coordinates of the probe location in units of m. The origin is (0, 0, 0).
repeated string variable_name = 2
The name of the variables to be retrieved by the probe.
optional int32 nt = 3
The total number of time steps that values are collected. This field will be replaced by the value computed from the flag input after b/142351512 is resolved.
optional int32 start_step_id = 4
The starting step of the simulation. This field will be replaced by the value defined by flag after b/142351512 is resolved.
message
biofuel_multistep.proto:22Parameters that are required to compute the source terms due to pyrolysis and char oxidation. Next id: 2
Used in:
optional wood = 1
message
radiative_transfer.proto:9Stores the parameters required by the radiation optics library. Next id: 6
Used in:
optional string longwave_nc_filepath = 1
Path of NetCDF file containing the longwave lookup tables.
optional string shortwave_nc_filepath = 2
Path of NetCDF file containing the shortwave lookup tables.
optional string cloud_longwave_nc_filepath = 3
Path of NetCDF file containing the cloud longwave lookup table.
optional string cloud_shortwave_nc_filepath = 4
Path of NetCDF file containing the cloud shortwave lookup table.
message
radiative_transfer.proto:69Used in:
optional optics = 1
The optics library that calculates optical depth, single-scattering albedo, and other local optical properties of the layered atmosphere.
optional atmospheric_state = 2
Data about the prevalent atmospheric gases present in the atmosphere as well as boundary conditions for the surface and top of atmosphere.
optional float update_cycle_seconds = 3
The time interval between updates of the radiative fluxes (in seconds). Since the RRTMGP model is very computationally expensive, it is highly recommended that the update cycle be no less than 10 minutes. However, too long an update cycle can lead to instabilities (Pauluis and Emanuel 2004, https://doi.org/10.1175/1520-0493(2004)132<0673:NIRFIC>2.0.CO;2).
optional float apply_cadence_seconds = 4
Supercycling time interval between applying the radiative transfer model in the energy equation (in seconds). When it is applied, its amplitude will be scaled larger appropriately. This option exists because the radiation update in the temperature equation can be too small relative to the existing temperature and be lost to floating point truncation in single precision. In practice, the supercycling time interval should be less than or equal to `update_cycle_seconds`. Furthermore, the supercycling time interval should be as small as possible, but large enough such that floating point precision is not an issue. If this field is left empty, or set to 0, we do no supercycling and apply the radiative heating at every step.
message
monitor.proto:43An analytics specification for a raw state, without any transformation or reduction. Note that if time averaging is enabled the actual value stored is the average of the state over time.
Used in:
(message has no fields)
message
rayleigh_damping_layer.proto:29Stores information required by the Rayleigh damping (sponge) layers. The RayleighDampingLayer proto defines a set of layers (zero or more per face) and the variables that interact with this set. Multiple RayleighDampingLayer messages are allowed in a single config but a variable can interact with at most one set of layers. This still allows different variables to be damped by different sets of sponge layers, e.g., velocity components might be damped on the sides and top of a domain and the same time rain content might be damped on all six faces. Next id: 5
Used in: ,
repeated orientation = 1
repeated variable_info = 2
repeated int32 target_value_mean_dim = 3
The direction(s) to take average for variables whose target value is not provided. This average value will be used as the target value for that variable. Valid values are 0, 1, and 2.
optional string beta_name = 4
Name of the variable that contains the damping coefficient beta in 'additional_states'. If not set, the default name of 'sponge_beta' will be used.
message
rayleigh_damping_layer.proto:32Information of the orientation of the sponge layer/layers. Next id: 5
Used in:
optional int32 dim = 1
The dimension along which the sponge layer is applied. Allowed values are 0, 1, and 2, which corresponds to the x, y, and z directions, respectively.
optional int32 face = 3
The face index at which the sponge is applied. Should be one of 0 and 1, where 0 suggests the sponge is arranged at the lower end of `dim`, and 1 is at the higher end of `dim`.
optional float fraction = 2
The fraction in the domain along `dim` that the sponge layer is applied. NB: the sponge layer is always applied close to the face with a larger index.
optional float a_coeff = 4
The coefficient used to compute the maximum magnitude of the sponge force. Scales inversely with the force.
message
rayleigh_damping_layer.proto:54The information required to compute the forcing term in the sponge layers. NB: only one target value can be applied to a single variable. Otherwise the connection between sponge layers is ambiguous. Next id: 6
Used in:
optional string name = 1
The name of the variable to which the sponge force is applied.
oneof target
The target value in the sponge layer for this specific variable. If none provided, then the target will be the mean of the field along the homogeneous dimensions.
float target_value = 2
The fixed target value of the sponge layer.
string target_state_name = 5
The name of the state to be used as a sponge target.
optional bool primitive = 4
An indicator of whether the sponge force is applied to a primitive variable or a conservative one. If 'true', the force term is generated for the primitive variable; otherwise the force term is for a conservative variable and needs to be multiplied by `rho`. For example, if the primitive variable is `phi`, then the corresponding conservative variable is `rho phi`. `phi` here can ben any velocity components or transported scalars. Setting the default to 'true' to match the behavior before adding this field.
Parameters required by the Rayleigh-damping method. With this method, a forcing term with constant damping coefficient is applied inside the solid for all variables listed.
Used in:
repeated variables = 1
Variables for which the Rayleigh damping method is applied.
optional float damping_coeff = 2
The value of the damping coefficient.
message
scalars.proto:23Defines the properties of a scalar to be included in the flow field. Next id: 16
Used in:
optional string name = 1
The name of the scalar.
optional float diffusivity = 2
The diffusivity of the scalar.
optional float density = 3
The density of the scalar, in units of kg/m^3. Setting default to 1.0 for a generic gas.
optional float molecular_weight = 4
The molecular weight of the scalar, in units kg/mol. Setting default to air for common uses that are not mixing or reacting.
optional bool solve_scalar = 5
An indicator for whether this scalar is solved in the flow system. Default setting to true, which indicates that scalars included in the textproto will be solved by default.
optional ConvectionScheme scheme = 6
The scheme to be used to discretize the convection term.
optional TimeIntegrationScheme time_integration_scheme = 10
The scheme to be used for time advancement for a scalar, and if absent it will fall back to the shared time integration scheme, specified in `SwirlLMParameters`'s `time_integration_scheme`: swirl_lm/base/parameters.proto
optional float reference_value = 7
A reference value for the scalar.
repeated diffusive_flux = 11
The diffusive flux to be applied at specific boundaries.
oneof scalar_config
Configurations for specific scalars.
generic_scalar = 8
total_energy = 9
humidity = 12
potential_temperature = 14
repeated override_bc_type = 15
Override the BC type for this scalar, which affects the convection term calculation.
message
scalars.proto:51Specifies a constant diffusive flux for the scalar if required.
Used in:
optional int32 dim = 1
The dimension of the diffusive flux. Allowed values are 0, 1, and 2, which corresponds to the x, y, and z directions, respectively.
optional int32 face = 3
The face index of the diffusive flux. Should be one of 0 and 1, where 0 suggests the flux is on the lower end of `dim`, and 1 is on the higher end of `dim`.
oneof flux
Specifies the value of the flux, or a variable name that stores the flux.
float value = 2
The value of the diffusive flux. This value will be applied on the entire boundary.
string varname = 4
The name of the variable in `additional_states` that specifies the flux. It is required that the flux specified this way has to be a plane that conforms with the dimension and representation of 3D flow field variables. For example, for a face in dim 0, the flux variable has to have a shape of (nz, 1, ny) or (nz, ny).
message
scalars.proto:90By default, the wall BC type (e.g. SLIP_WALL, NON_SLIP_WALL) used for scalar transport convection term calculation is derived from velocity BC. This allows the overriding of the derived BC for a specific scalar in a specific dimension, on a specific face. This will set the BC type to UNKNOWN, which affects the convection term calculation for this scalar at the boundary, e.g. when the original boundary type is a wall.
Used in:
optional int32 dim = 1
The dimension of the wall BC type to be overriden. Allowed values are 0, 1, and 2, which corresponds to the x, y, and z directions, respectively.
optional int32 face = 2
The face index of the wall BC type to be overriden. Should be one of 0 and 1, where 0 indicates the flux is on the lower end of `dim`, and 1 is on the higher end of `dim`.
Stores information required by the simulated turbulent inflow library. Next id: 8
Used in:
optional int32 inflow_dim = 1
Specifies the dimension of the inflow. A 2D plane perpendicular to this dimension will be retrieved as the inflow.
oneof operation
Specifies if the current simulation is for inflow generation or enforcement.
generation = 2
The inflow handler is used for inflow data generation.
enforcement = 3
The inflow handler is used for inflow boundary condition enforcement.
optional int32 nt = 4
Specifies the total number of time steps to be collected/loaded as the inflow data. Needs to be fully divisible by the number of cores along the inflow dimension.
optional int32 start_step_id = 5
Specifies the index in terms of time step at which to start the inflow data collection or boundary condition enforcement.
optional float delta_t = 6
Specifies the interval of time between 2 consecutive inflow snapshots to be collected/imposed as boundary condition in the inflow data.
repeated string scalar = 7
Specifies the names of scalars for which the inflow is collected/enforced.
Stores information required to apply the inflow generated by another simulation. Next id: 5
Used in:
optional string inflow_data_dir = 1
Specifies the directory of the inflow data file.
optional string inflow_data_prefix = 2
Specifies the prefix of the inflow data file.
optional int32 inflow_data_step = 3
Specifies the step where the inflow data file is loaded.
optional int32 face = 4
Specifies the face where inflow is coming from.
Stores information required to generate the inflow. Next id: 2
Used in:
optional float location = 1
Specifies the location in physical coordinates (i.e. in units of m) where the 2D plane is obtained along `inflow_dim`.
message
parameters.proto:38Methods for how the simulation time, including the number of cycles (`num_cycles`) and number of steps per cycles (`num_steps`), are determined. Next id: 4
Used in:
oneof simulation_time_method
from_flags = 1
from_config = 2
from_flow_through_time = 3
message
parameters.proto:43Parameters are passed in from the config file.
Used in:
optional int32 num_cycles = 1
optional int32 num_steps = 2
message
parameters.proto:40Parameters are passed in from flags.
Used in:
(message has no fields)
message
parameters.proto:53Parameters are derived from the flow through times that is computed as l / bc_u in the `mean_flow_dim`. Note that this option is only valid if the face with index `inflow_face` along the `mean_flow_dim` is associated with an inflow boundary type. Next id: 5
Used in:
optional int32 num_cycles = 1
The number of cycles the simulation runs. This parameter determines the total number of restart files to be dumped.
optional int32 mean_flow_dim = 2
The dimension along with the flow through time is computed. Must be one of 0, 1, and 2.
optional int32 inflow_face = 3
The face from which the inflow is going into the domain. 0 for the lower index end, and 1 for the higher index end.
optional float n_flow_through_time = 4
The total number of flow through times that the simulation needs to cover.
message
monitor.proto:65Stores information about analytics requests for a single state.
Used in:
optional string state_name = 1
The name of the field or state from which the analytics will be computed.
repeated analytics = 2
The list of analytics specifications for this state.
message
parameters.proto:131Stores information about a sub-grid scale model. Next id: 9
Used in:
oneof sgs_model_type
smagorinsky = 1
dynamic_smagorinsky = 2
smagorinsky_lilly = 3
vreman = 4
optional float nu_t_max = 8
An upper bound of the turbulent viscosity.
optional float diff_t_max = 5
An upper bound of the turbulent diffusivity.
optional float nu_t_min = 6
A lower bound of the turbulent viscosity.
optional float diff_t_min = 7
A lower bound of the turbulent diffusivity.
message
parameters.proto:157Parameters required by the dynamic Smagorinsky model.
Used in:
optional bool periodic_x = 1
An indicator of periodicity in the x direction.
optional bool periodic_y = 2
An indicator of periodicity in the y direction.
optional bool periodic_z = 3
An indicator of periodicity in the z direction.
message
parameters.proto:172Parameters required by the Smagorinsky-Lilly model. Default values are retrieved from reference: Stevens, Bjorn, Chin-Hoh Moeng, Andrew S. Ackerman, Christopher S. Bretherton, Andreas Chlond, Stephan de Roode, James Edwards, et al. 2005. “Evaluation of Large-Eddy Simulations via Observations of Nocturnal Marine Stratocumulus.” Monthly Weather Review 133 (6): 1443–62.
Used in:
optional float c_s = 1
The Smagonrinsky constant.
optional float pr_t = 2
The turbulent Prandtl number.
optional bool use_pr_t = 3
An indicator of whether the turbulent diffusivity is computed using the turbulent Prandtl number, or from the scalar gradient directly. Default to use the turbulent Prandtl number to match the original behavior.
message
parameters.proto:133Parameters required by the constant Smagorinsky model.
Used in:
optional float c_s = 1
The Smagonrinsky constant.
optional float pr_t = 2
The turbulent Prandtl number.
optional bool use_pr_t = 3
An indicator of whether the turbulent diffusivity is computed using the turbulent Prandtl number, or from the scalar gradient directly. Default to use the turbulent Prandtl number to match the original behavior.
optional SmagorinskyModel.DeltaFormula delta_formula = 4
Note that the default is DIAGONAL for backward compatibility but GEOMETRIC_MEAN is preferred especially with high aspect ratio grids.
Used in:
UNKNOWN = 0
DIAGONAL = 1
Delta coefficient is sqrt(dx^2 + dy^2 + dz^2).
GEOMETRIC_MEAN = 2
Delta coefficient is (dx * dy * dz) ^ (1/3).
message
parameters.proto:188Parameters required by the Vreman model. Reference: Vreman, A. W. 2004. “An Eddy-Viscosity Subgrid-Scale Model for Turbulent Shear Flow: Algebraic Theory and Applications.” Physics of Fluids 16 (10): 3670–81.
Used in:
optional float c_s = 1
The Smagonrinsky constant. Default value is taken from the reference.
optional float pr_t = 2
The turbulent Prandtl number. Default value is taken from the reference.
message
parameters.proto:236Stores the parameters required by an incompressible Navier-Stokes simulation. Next id: 43
optional grid_params = 1
The mesh information.
optional SwirlLMParameters.KernelOpType kernel_op_type = 27
The type of kernel operator to be used to represent finite difference operators. Default set to `KERNEL_OP_CONV` to match previous behavior.
optional ConvectionScheme convection_scheme = 2
The scheme used to discretize the convection term.
optional NumericalFlux numerical_flux = 35
The numerical flux for the convection term. Setting default to upwinding for backward compatibility.
optional DiffusionScheme diffusion_scheme = 25
The scheme used to discretize the diffusion term.
optional float diff_stab_crit = 42
The stability limit of diffusion. It sets an upper bound for the viscosity and diffusivity, including those from both kinematic and sub-grid scale (if used), so that nu <= diff_stab_crit h^2 / dt, with h being the minimum of dx, dy, and dz. If it is not set, no upper bound is applied.
optional TimeIntegrationScheme time_integration_scheme = 3
The scheme used for the time integration, which is shared for momentum/ velocity and scalars' time advancement by default. When one needs a different time integration scheme for scalars, one could explicitly add `Scalar`'s `time_integration_scheme` field in: swirl_lm/equations/scalars.proto In this case, the scalar specific one will overwrite the shared one here.
optional simulation_time_info = 33
The option for how the number of cycles and steps are determined. If not set, `num_cycles` and `num_steps` will be set from flags.
optional pre_post_process_info = 34
The option for how the pre- and post-process options are specified. If not set, these options will be determined from flags.
optional bool enable_scalar_recorrection = 30
An option for enabling the correction of primitive scalars after the density update from the equation of state. If it is `true`, results of primitive scalars will be updated by the density computed at the current subiteration; otherwise they are stay the same as the ones computed from the scalar-prediction step. Default set to `true` for backward compatibility. Note that scalars oscillations are mitigated with this option being `false` in cases with combustion.
optional bool enable_rhie_chow_correction = 31
An option for enabling the Rhie-Chow correction of the face-interpolated momentum in the convection term of the momentum equation. This correction mitigates oscillations in the pressure field and flow field by coupling the two explitictly. Default set to `true` for backward compatibility. Note that this may create instability if the solver is already introducing some degree of coupling between the pressure and the flow field.
repeated boundary_conditions = 5
The boundary conditions for all variables.
optional int32 num_pressure_iterations = 6
The number of sub-iterations of the pressure solver.
optional pressure = 24
Options for the pressure solving step.
optional int32 num_sub_iterations = 18
The number of sub-iterations within each time step in the Crank-Nicolson scheme.
optional float density = 7
The density of the flow field [kg/m^3].
optional float kinematic_viscosity = 8
The kinematic viscosity of the flow field [m^2/s].
optional float p_thermal = 15
The thermodynamic pressure of the flow field [Pa]. Default set to 1 bar, which is the standard atmospheric condition.
optional SwirlLMParameters.SolverProcedureType solver_procedure = 9
The procedure for pressure and momentum updates in the solver.
repeated scalars = 10
The names of transported scalars.
repeated string additional_state_keys = 11
The names of additional states, which are constants that will be used in the simulation, e.g. boundary condition etc.
repeated string helper_var_keys = 20
The names of the variables that are used as helper in computation. These variables are not subjected to the splitting in z-direction, and they don't have to be of the same size as the mesh.
optional gravity_direction = 12
The direction vector of gravity if it is considered in the simulation. The default case of (0, 0, 0) corresponds to the case of no gravity.
optional bool use_sgs = 13
The option of using sub-grid scale model. If `False`, the simulation is DNS, otherwise it's an LES. Default solver is DNS.
optional sgs_model = 16
The choice of sub-grid scale model to use in the simulation.
optional SwirlLMParameters.DensityUpdateOption density_update_option = 14
The option of updating density. This will be deprecated and replaced by `thermodynamics`.
optional thermodynamics = 22
The thermodynamic model that's used to update the density.
optional combustion = 26
Information required by combustion models.
optional turbulent_combustion = 38
Information required by the turbulent-combustion model. The turbulent- combustion model is a closure model for combustion. It does not provide the reaction source terms due to combustion. It should only be used when a combustion model is defined. Note that the turbulent combustion model is a closure model for combustion in the context of large-eddy simulation. It does not consider the modeling of source terms due to chemical reaction, thus is configured independently from the combustion model.
repeated string states_from_file = 17
A filter of variable names to be loaded from files if the filter is used. The option for using this filter will be set by a command line flag.
repeated string states_to_file = 32
A filter of variable names to be dumped to files.
optional sponge_layer = 21
Information required for sponge layers if applied. This will be deprecated, and contained in `boundary_models`.
optional boundary_models = 23
Information required for boundary models if applied.
optional monitor_spec = 28
Specification of analytics monitoring variables.
optional probe = 29
Specification of probes that retrieves values at user specified locations.
optional bool use_3d_tf_tensor = 36
If True, all field variables are 3D tf.Tensor. Otherwise, they are Sequence[tf.Tensor].
optional radiative_transfer = 37
The radiation model that solves a two-stream radiative transfer equation taking into account the full atmospheric state.
optional lpt = 41
The Lagrangian particle tracking model that solves the motion of particles in a fluid flow.
repeated string debug_variables = 39
Names of debug variables to save at the end of each cycle. When adding code to output a new debug variable, update the list below, which serves as documentation for available debug variables. Available Debug Variables -------------------------------------------------------------------------
optional microphysics = 40
The cloud microphysics parameterization.
Defines the method types for density update. This will be deprecated and replaced by `thermodynamics.Thermodynamics`.
Used in:
DENSITY_UPDATE_UNKNOWN = 0
The default option where density is not updated. A constant density is used.
DENSITY_UPDATE_LINEAR_MIXING = 1
The option for updating density with a linear mixing rule.
DENSITY_UPDATE_EOS = 2
The option for updating density from the equation of state.
DENSITY_UPDATE_WATER = 3
The option for updating density with the water thermodynamics.
Defines the type of kernel operator to be used in the simulation algorithm.
Used in:
KERNEL_OP_UNKNOWN = 0
An unimplemented kernel operator type.
KERNEL_OP_CONV = 1
The option for using convolution to perform finite difference operations.
KERNEL_OP_SLICE = 2
The option for using slicing to perform finite difference operations.
KERNEL_OP_MATMUL = 3
The option for using matrix multiplication to perform finite difference operations.
Defines the type of the simulation procedure to be used in the solver.
Used in:
UNKNOWN = 0
The default option where no solver procedure is specified. Results in an error in this case.
SEQUENTIAL = 1
The sequential procedure that first updates pressure then velocity.
VARIABLE_DENSITY = 3
The variable-density low Mach number solver.
Defines types of turbulent kinetic energy (TKE) models with required parameters.
Used in:
oneof tke_model_option
constant = 1
algebraic = 2
turbulent_viscosity = 3
Computes the TKE based on flow field variables algebraically.
Used in:
(message has no fields)
Sets the TKE to a constant.
Used in:
optional float tke_constant = 1
Derives the TKE from the turbulent viscosity.
Used in:
(message has no fields)
message
thermodynamics.proto:22A library of thermodynamics in a fluid simulation.
Used in:
oneof thermodynamics_type
linear_mixing = 1
ideal_gas_law = 2
water = 3
constant_density = 4
optional Thermodynamics.SolverMode solver_mode = 5
The model of the solver for density representation.
Used in:
UNKNOWN = 0
Unsupported solver mode.
LOW_MACH = 1
The mode for representing density in the low-Mach number variable density approach. In this approach, the thermodynamic density is used to compute all conservative variables, hence there's a strong coupling between the momentum and thermodynamical quantities.
ANELASTIC = 2
The mode for representing density in the anelastic approach. In this approach, the reference density (constant with respect to time), is used to compute all conservative variables. The thermodynamic density is used to compute the buoyancy term only, which conforms with the Boussinesq approximation.
message
monitor.proto:72Used in:
optional float start_time_seconds = 1
Physical time (in seconds) to start computing time-averaged analytics. If this field is unset, the averaging will start from step 0.
optional float end_time_seconds = 2
Physical time (in seconds) to stop updating time-averaged analytics. If unset, the end time is assumed to be the end of the simulation.
Defines the type of time integration schemes.
Used in: , ,
TIME_SCHEME_UNKNOWN = 0
The default option where no scheme is used. Should result in an error.
TIME_SCHEME_RK3 = 1
The third order Runge Kutta scheme.
TIME_SCHEME_CN_EXPLICIT_ITERATION = 2
The semi-implicit Crank-Nicolson scheme with explicit subiterations.
message
scalars.proto:110Defines configurations for total energy. Next id: 6
Used in:
optional bool include_radiation = 1
An option of whether radiation is included in the total energy equation.
optional bool include_subsidence = 2
An option of whether the effect of subsidence velocity is included in the total energy equation.
message
turbulent_combustion.proto:29The turbulent combustion model selector. Next id: 2
Used in:
oneof turbulent_combustion_model
const_tf = 1
The Thickened Flame model with constant coefficients.
message
thermodynamics.proto:85A library for parameters required by the water thermodynamics. Next id: 29
Used in:
optional float r_v = 1
The gas constant of water vapor, in unit of J/kg/K. The default value is computed based on treating the molecular weight of water as 0.018 kg/mol.
optional float t_0 = 2
The reference temperature, in units of K. The default value is set at 0 degree Celsius.
optional float t_min = 3
The minimum temperature allowed, in units of K.
optional float t_freeze = 4
The temperature at freezing condition, in units of K.
optional float t_triple = 5
The triple point temperature, in units of K. Source for the triple point values: engineeringtoolbox.com/critical-point-water-steam-d_834.html
optional float t_icenuc = 25
The nucleation temperature, in units of K. Default value obtained from CliMa: https://github.com/CliMA/CLIMAParameters.jl/blob/main/src/Planet/planet_parameters.jl
optional float p_triple = 6
The triple point pressure, in units of Pa.
optional float p00 = 27
The reference pressure used in the definition of potential temperature, in units of Pa. TODO(sheide): Double check the consistency of this parameter with `p_thermal`.
optional float e_int_v0 = 7
The reference specific internal energy of water vapor, in units of J/kg. The default value derived based on CLIMA design doc, Eq. 2.11.
optional float e_int_i0 = 8
The reference specific internal energy of ice, in units of J/kg. The default value derived based on CLIMA design doc, Eq. 2.11.
optional float lh_v0 = 9
The latent heat of vaporization, in unit of J/kg. The default value is taken from http://www.splung.com/content/sid/6/page/latentheat.
optional float lh_s0 = 10
The latent heat of fusion, in unit of J/kg. The default value is taken from http://www.splung.com/content/sid/6/page/latentheat.
optional float cv_d = 11
Specific heats of the dry air at constant volume, J/kg/K. Sources for values below: 1. Pressel, Kyle G., Colleen M. Kaul, Tapio Schneider, Zhihong Tan, and Siddhartha Mishra. 2015. “Large-Eddy Simulation in an Anelastic Framework with Closed Water and Entropy Balances: LARGE-EDDY SIMULATION FRAMEWORK.” Journal of Advances in Modeling Earth Systems 7 (3): 1425–56. 2. https://www.engineeringtoolbox.com/water-properties-d_1508.html.
optional float cv_v = 12
Specific heats of water vapor at constant volume, J/kg/K.
optional float cv_l = 13
Specific heats of liquid water at constant volume, J/kg/K.
optional float cv_i = 14
Specific heats of ice at constant volume, J/kg/K.
optional float cp_v = 15
Specific heats of water vapor at constant pressure, J/kg/K.
optional float cp_l = 16
Specific heats of liquid water at constant pressure, J/kg/K.
optional float cp_i = 17
Specific heats of ice at constant pressure, J/kg/K.
optional int32 max_temperature_iterations = 18
The maximum number of iterations for the secant solver for temperature.
optional float temperature_tolerance = 19
The tolerance of the secant solver for temperature's function f.
optional float temperature_successive_tol = 24
The atol and rtol of temperature when running iterations with Newton method, recommended value is < 1e-6, down to machine precision 1e-7 (with tf.float32) or even totally turned off (by setting it to be non-positive), unless there is enough information about the `f` function. To be backward compatible, when unset it falls back to reuse `temperature_tolerance`, though it's not recommended.
optional int32 num_density_iterations = 20
The number of iterations for density computation.
optional bool use_fast_thermodynamics = 28
Whether to use the fast thermodynamics solver (only applicable when the prognostic variables are theta_li and q_t; no effect otherwise.)
oneof reference_state
geo_static_reference_state = 21
const_theta_reference_state = 22
const_reference_state = 23
user_defined_reference_state = 26
message
thermodynamics.proto:200An option of the reference state. This option assumes the thermodynamic states are constants regardless of the height.
Used in:
optional float t_ref = 1
The reference temperature in units of K, e.g. the sea surface temperature, the far field temperature.
message
thermodynamics.proto:185An option of the reference state. This option assumes the potential temperature is a constant. Next id: 5
Used in:
optional float theta = 1
An indicator of whether constant potential temperature is used to define the reference/hydrostatic pressure. Do not define this field if the potential temperature in the simulation setup is not a constant.
optional float q_t = 2
The total humidity in the reference state.
optional float q_l = 3
The liquid humidity in the reference state.
optional float q_i = 4
The ice humidity in the reference state.
message
thermodynamics.proto:169An option of the reference state. This option assumes the hydrostatic temperature follows a tanh profile, as specified in CliMa design doc, p 50, Eq. 7.3. Next id: 4
Used in:
optional float t_s = 1
The surface temperature, in units of K. The default value is provided in the CliMa design doc.
optional float height = 2
The height of the domain, in units of meter. Default value roughly represents of Earth’s midlatitude atmosphere.
optional float delta_t = 3
The temperature difference between the top and bottom of the domain, in units of K. Default value roughly represents of Earth’s midlatitude atmosphere.
message
thermodynamics.proto:213An option of the reference state where the profiles for pressure and potential temperature is defined by the user. With this option, it is required that `p_ref` and `theta_ref` are provided as additional_states. If `q_t_init` is also in additional_states, it will be used to compute the reference state; otherwise it is assumed that q_t = 0 in the reference state. The recommended practice for setting these states is to enforce the hydrostatic balance condition for all thermodynamics variables.
Used in:
(message has no fields)
message
wood.proto:34A library for parameters required by the wood combustion model. References: [1] Linn, Rodman Ray. 1997. “A Transport Model for Prediction of Wildfire Behavior (No. LA-13334-T).” Edited by Francis H. Harlow. Ph.D, Los Alamos National Lab., NM (United States). [2] Linn, Rodman R. 2005. “Numerical Simulations of Grass Fires Using a Coupled Atmosphere–fire Model: Basic Fire Behavior and Dependence on Wind Speed.” Journal of Geophysical Research 110 (D13): 287. Next id: 23
Used in: ,
optional float s_b = 1
The B scale of the fuel elements, in units of m.
optional float s_x = 2
The length scale of the smallest fuel elements, in units of m. As the length scale decreases, the reaction rate increases.
optional float h_conv = 3
The convective heat transfer coefficient, W/m²/K.
optional float a_v = 4
The ratio of the surface area of the fuel to the resolved volume (surface area per unit volume of fuel times the volume fraction).
optional float cp_g = 5
The specific heats at constant pressure of the combined gas, J/kg/K.
optional float h_f = 6
The heat energy per unit mass associated with the reaction, J/kg.
optional float t_pyr = 7
The temperature at which the solid fuel begins to pyrolyze.
optional int32 n_step = 8
Number of RK3 iterations with each time step for the integration of reaction source term.
optional bool include_radiation = 9
The option of including radiation in the fire source term. Default set to `false` to match behavior before change.
oneof t_far_field
The ambient air temperature in K. This is only used when `include_radiation` is true.
float t_ambient = 10
Far-field temperature as a constant.
string t_variable = 17
Far-field temperature from a flow field variable. This variable provides the name of this varialbe.
optional float efficiency = 11
The efficiency factor that combines the effect of sub-grid scale temperature and emissivity. Default value set to 1 based one reference [1].
optional float c_f = 12
An empirical scaling coefficient in local fire reaction rates. This is number between 0.07 and 0.9. Default set to 0.9 suggested by FireTec.
optional TimeIntegrationScheme reaction_integration_scheme = 13
The option of integration scheme to be used to compute the reaction source term.
oneof combustion_model_option
The type of wood combustion model.
dry_wood = 14
moist_wood = 15
optional tke = 16
Defines the turbulent kinetic energy model to be used to compute the reaction source terms.
optional float t_0_ivf = 18
Defines the linear ramp function for ignited volume fraction (ivf). At T=t_0_ivf the fraction is 0 and at T=t_1_ivf, it is 1. See Figure 4.1 in [1].
optional float t_1_ivf = 19
optional bool apply_temperature_filter = 22
The following three parameters are used to filter the temperature field before computing the reaction source term. The option of applying the temperature filter to the temperature field before computing the reaction source term.
optional float w_axis = 20
The fraction of the weights to be applied along the axes.
optional float w_center = 21
The fraction of the weights to be applied at the center in the 3 x 3 stencil.
message
wood.proto:92Parameters required by the dry wood combustion model.
Used in:
(message has no fields)
message
wood.proto:78Parameters required by the combustion model with moisture.
Used in:
optional float h_w = 1
The heat energy per unit mass associated with liquid water evaporation, in units of J/kg. The default value is taken at 100 Celsius degree. Reference: https://www.engineeringtoolbox.com/water-properties-d_1573.html
optional float t_vap = 2
The temperature at which the liquid water evaporates, in units of K. Default temperature set to 100 Celsius degree.
optional float c_w = 3
An empirical scaling coefficient for the evaporation rate.