Physical fields

This page lists all supported physical fields. Every field is identified with an unique key, e.g. temp_3d. The field metadata is defined in field_defs module.

Fields are stored in solver’s fields dictionary: one can access a field Function using:

# dictionary access
solver_obj.fields['temp_3d']
# or attribute access
solver_obj.fields.temp_3d

List of fields

  • baroc_head_3d: Baroclinic head [m]

    • output file: BaroHead3d.pvd
  • bathymetry_2d: Bathymetry [m]

    • output file: bathymetry2d.pvd
  • bathymetry_3d: Bathymetry [m]

    • output file: bathymetry3d.pvd
  • bottom_drag_2d: Bottom drag coefficient [-]

    • output file: BottomDrag2d.pvd
  • bottom_drag_3d: Bottom drag coefficient [-]

    • output file: BottomDrag3d.pvd
  • buoy_freq_3d: Buoyancy frequency squared [s-2]

    • output file: BuoyFreq3d.pvd
  • coriolis_2d: Coriolis parameter [s-1]

    • output file: coriolis_2d.pvd
  • coriolis_3d: Coriolis parameter [s-1]

    • output file: coriolis_3d.pvd
  • density_3d: Water density [kg m-3]

    • output file: Density3d.pvd
  • eddy_diff_3d: Eddy diffusivity [m2 s-1]

    • output file: EddyDiff3d.pvd
  • eddy_visc_3d: Eddy Viscosity [m2 s-1]

    • output file: EddyVisc3d.pvd
  • elev_2d: Water elevation [m]

    • output file: Elevation2d.pvd
  • elev_3d: Water elevation [m]

    • output file: Elevation3d.pvd
  • elev_cg_2d: Water elevation CG [m]

    • output file: ElevationCG2d.pvd
  • elev_cg_3d: Water elevation CG [m]

    • output file: ElevationCG3d.pvd
  • eps_3d: TKE dissipation rate [m2 s-2]

    • output file: TurbEps3d.pvd
  • h_elem_size_2d: Element size in horizontal direction [m]

    • output file: h_elem_size_2d.pvd
  • h_elem_size_3d: Element size in horizontal direction [m]

    • output file: h_elem_size_3d.pvd
  • hcc_metric_3d: HCC mesh quality [-]

    • output file: HCCMetric3d.pvd
  • int_pg_3d: Internal pressure gradient [m s-2]

    • output file: IntPG3d.pvd
  • len_3d: Turbulent length scale [m]

    • output file: TurbLen3d.pvd
  • max_h_diff: Maximum stable horizontal diffusivity [m2 s-1]

    • output file: MaxHDiffusivity3d.pvd
  • parab_visc_3d: Parabolic Viscosity [m2 s-1]

    • output file: ParabVisc3d.pvd
  • psi_3d: Turbulence psi variable [-]

    • output file: TurbPsi3d.pvd
  • salt_3d: Water salinity [psu]

    • output file: Salinity3d.pvd
  • shear_freq_3d: Vertical shear frequency squared [s-2]

    • output file: ShearFreq3d.pvd
  • smag_visc_3d: Smagorinsky viscosity [m2 s-1]

    • output file: SmagViscosity3d.pvd
  • split_residual_2d: Momentum eq. residual for mode splitting [m s-2]

    • output file: SplitResidual2d.pvd
  • temp_3d: Water temperature [C]

    • output file: Temperature3d.pvd
  • tke_3d: Turbulent Kinetic Energy [m2 s-2]

    • output file: TurbKEnergy3d.pvd
  • uv_2d: Depth averaged velocity [m s-1]

    • output file: Velocity2d.pvd
  • uv_3d: Horizontal velocity [m s-1]

    • output file: Velocity3d.pvd
  • uv_bottom_2d: Bottom velocity [m s-1]

    • output file: BottomVelo2d.pvd
  • uv_bottom_3d: Bottom velocity [m s-1]

    • output file: BottomVelo3d.pvd
  • uv_dav_2d: Depth averaged velocity [m s-1]

    • output file: DAVelocity2d.pvd
  • uv_dav_3d: Depth averaged velocity [m s-1]

    • output file: DAVelocity3d.pvd
  • uv_mag_3d: Magnitude of horizontal velocity [m s-1]

    • output file: VeloMag3d.pvd
  • uv_p1_3d: P1 projection of horizontal velocity [m s-1]

    • output file: VeloCG3d.pvd
  • v_elem_size_2d: Element size in vertical direction [m]

    • output file: VElemSize2d.pvd
  • v_elem_size_3d: Element size in vertical direction [m]

    • output file: VElemSize3d.pvd
  • w_3d: Vertical velocity [m s-1]

    • output file: VertVelo3d.pvd
  • w_mesh_3d: Mesh velocity [m s-1]

    • output file: MeshVelo3d.pvd
  • w_mesh_surf_2d: Surface mesh velocity [m s-1]

    • output file: SurfMeshVelo3d.pvd
  • w_mesh_surf_3d: Surface mesh velocity [m s-1]

    • output file: SurfMeshVelo3d.pvd
  • wind_stress_3d: Wind stress [Pa]

    • output file: wind_stress_3d.pvd
  • z_bottom_2d: Bottom cell z coordinates [m]

    • output file: ZBottom2d.pvd
  • z_coord_3d: Mesh z coordinates [m]

    • output file: ZCoord3d.pvd
  • z_coord_ref_3d: Static mesh z coordinates [m]

    • output file: ZCoordRef3d.pvd