FV3-JEDI
fv3jedi_state_mod Module Reference

Data Types

type  fv3jedi_state
 Fortran derived type to hold FV3JEDI state. More...
 

Functions/Subroutines

subroutine add_incr (self, geom, rhs_fields)
 
subroutine analytic_ic (self, geom, conf, vdate)
 Analytic Initialization for the FV3 Model. More...
 

Function/Subroutine Documentation

◆ add_incr()

subroutine fv3jedi_state_mod::add_incr ( class(fv3jedi_state), intent(inout)  self,
type(fv3jedi_geom), intent(inout)  geom,
type(fv3jedi_field), dimension(:), intent(in)  rhs_fields 
)
private

Definition at line 42 of file fv3jedi_state_mod.F90.

Here is the call graph for this function:

◆ analytic_ic()

subroutine fv3jedi_state_mod::analytic_ic ( class(fv3jedi_state), intent(inout)  self,
type(fv3jedi_geom), intent(inout)  geom,
type(fckit_configuration), intent(in)  conf,
type(datetime), intent(inout)  vdate 
)
private

Analytic Initialization for the FV3 Model.

analytic_IC() initializes the FV3JEDI state and State objects using one of several alternative idealized analytic models. This is intended to facilitate testing by eliminating the need to read in the initial state from a file and by providing exact expressions to test interpolations. This function is activated by setting the "analytic_init" state in the "initial" or "statefile" section of the configuration file.

Initialization options that begin with "dcmip" refer to tests defined by the multi-institutional 2012 Dynamical Core Intercomparison Project and the associated Summer School, sponsored by NOAA, NSF, DOE, NCAR, and the University of Michigan.

Currently implemented options for analytic_init include:

  • dcmip-test-1-1: 3D deformational flow
  • dcmip-test-1-2: 3D Hadley-like meridional circulation
  • dcmip-test-3-1: Non-hydrostatic gravity wave
  • dcmip-test-4-0: Baroclinic instability
Author
M. Miesch (adapted from a pre-existing call to invent_state)
Date
March, 2018: Created
May, 2018: Added dcmip-test-3-1
June, 2018: Added dcmip-test-4-0
Warning
This routine does not initialize the fv3jedi_interp member of the fv3jedi_state object
Though an input state file is not required for these analytic initialization routines, some grid information (in particular the hybrid vertical grid coefficients ak and bk) is still read in from an input file when creating the geometry object that is a required member of fv3jedi_state; see c_fv3jedi_geo_setup() in fv3jedi_geom_mod.F90.
Parameters
[in,out]selfState
[in,out]geomGeometry
[in]confConfiguration
[in,out]vdateDateTime

Definition at line 246 of file fv3jedi_state_mod.F90.