dyn_core

AcousticDynamics

Fortran name is dyn_core Performs the Lagrangian acoustic dynamics described by Lin 2004

__init__(comm, stencil_factory, quantity_factory, grid_data, damping_coefficients, grid_type, nested, stretched_grid, config, phis, wsd, state, checkpointer=None)

Parameters:

Name	Type	Description	Default
comm	Communicator	object for tile or cubed-sphere inter-process communication	required
stencil_factory	StencilFactory	creates stencils	required
quantity_factory	QuantityFactory	creates quantities	required
grid_data	GridData	metric terms defining the grid	required
damping_coefficients	DampingCoefficients	damping configuration	required
grid_type		grid geometry used	required
nested		if the grid contains a nested, high-res region	required
stretched_grid		if the grid is stretched so tile faces cover different areas	required
config	AcousticDynamicsConfig	configuration settings	required
pfull		atmospheric Eulerian grid reference pressure (Pa)	required
phis	FloatFieldIJ	surface geopotential height	required
checkpointer	Optional[Checkpointer]	if given, used to perform operations on model data at specific points in model execution, such as testing against reference data	None

gz_from_surface_height_and_thicknesses(zs, delz, gz)

Parameters:

Name	Type	Description	Default
zs	in	surface height	required
delz	in	layer thickness	required
gz	out	geopotential height	required

interface_pressure_from_toa_pressure_and_thickness(delp, pem, ptop)

Parameters:

Name	Type	Description	Default
delp	in	pressure thickness of atmospheric layer	required
pem	out	interface pressure	required
ptop	in	pressure at top of atmosphere	required

p_grad_c_stencil(rdxc, rdyc, uc, vc, delpc, pkc, gz, dt2)

Update C-grid winds from the backwards-in-time pressure gradient force

When this is run the C-grid winds have almost been completely updated by computing the momentum equation terms, but the pressure gradient force term has not yet been applied. This stencil completes the equation and Arakawa C-grid winds have been advected half a timestep upon completing this stencil.

Parameters:

Name	Type	Description	Default
rdxc	in		required
rdyc	in		required
uc	inout	x-velocity on the C-grid, has been updated due to advection but not yet due to pressure gradient force	required
vc	inout	y-velocity on the C-grid, has been updated due to advection but not yet due to pressure gradient force	required
delpc	in	vertical delta in pressure	required
pkc	in	pressure if non-hydrostatic, (edge pressure)**(moist kappa) if hydrostatic	required
gz	in	height of the model grid cells (m)	required
dt2	in	half a model timestep (for C-grid update) in seconds	required

zero_data(mfxd, mfyd, cxd, cyd, heat_source, diss_estd, first_timestep)

Parameters:

Name	Type	Description	Default
mfxd	out	mass flux in x direction	required
mfyd	out	mass flux in y direction	required
cxd	out	courant number in x direction	required
cyd	out	courant number in y direction	required
heat_source	out	heat accumulated from diffusion of kinetic energy gets applied at the end of all acoustic steps	required
diss_estd	out	how much energy is dissipated, is mainly captured to send to the stochastic physics (in contrast to heat_source)	required
first_timestep	in	is this the first acoustic timestep?	required