Skip to content

fv_dynamics

DynamicalCore

Corresponds to fv_dynamics in original Fortran sources.

__init__(comm, grid_data, stencil_factory, quantity_factory, damping_coefficients, config, phis, state, timestep, checkpointer=None)

Parameters:

Name Type Description Default
comm Communicator

object for cubed sphere or tile inter-process communication

required
grid_data GridData

metric terms defining the model grid

required
stencil_factory StencilFactory

creates stencils

required
damping_coefficients DampingCoefficients

damping configuration/constants

required
config DynamicalCoreConfig

configuration of dynamical core, for example as would be set by the namelist in the Fortran model

required
phis Quantity

surface geopotential height

required
state DycoreState

model state

required
timestep timedelta

model timestep

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

step_dynamics(state, timer=NullTimer())

Step the model state forward by one timestep.

Parameters:

Name Type Description Default
timer Timer

keep time of model sections

NullTimer()
state DycoreState

model prognostic state and inputs

required

log_on_rank_0(msg)

Print when rank is 0 - outside of DaCe critical path

omega_from_w(delp, delz, w, omega)

Parameters:

Name Type Description Default
delp in

vertical layer thickness in Pa

required
delz in

vertical layer thickness in m

required
w in

vertical wind in m/s

required
omega out

vertical wind in Pa/s

required

pt_to_potential_density_pt(pkz, dp_initial, q_con, pt)

Parameters:

Name Type Description Default
pkz in
required
dp_initial in
required
q_con in
required
pt out

temperature when input, "potential density temperature" when output

required