![]() |
Jump to DART Documentation Main Index |
DART interface module for the 'null_model'. This model provides very simple models for evaluating filtering algorithms. It can provide simple linear growth around a fixed point, a random draw from a Gaussian, or combinations of the two. Namelist controls can set the width of the Gaussian and change both the model advance method and the expected observation interpolation method.
The 18 public interfaces are standardized for all DART compliant models. These interfaces allow DART to advance the model, get the model state and metadata describing this state, find state variables that are close to a given location, and do spatial interpolation for model state variables.
This namelist is read from the file input.nml. Namelists start with an ampersand '&' and terminate with a slash '/'. Character strings that contain a '/' must be enclosed in quotes to prevent them from prematurely terminating the namelist.
&model_nml model_size = 2, delta_t = 0.05, time_step_days = 0, time_step_seconds = 3600 noise_amplitude = 0.0_r8 advance_method = 'simple' interpolation_method = 'standard' /
Item | Type | Description |
---|---|---|
model_size | integer | Model size. |
delta_t | real(r8) | Internal model timestep parameter. |
time_step_days | integer | Minimum model advance time in days. |
time_step_seconds | integer | Minimum model advance time in seconds. |
noise_amplitude | real(r8) | If greater than 0.0 sets the standard deviation of the added Gaussian noise during the model advance. |
advance_method | character(64) | Controls the model advance method. The default is 'simple' timestepping. A 4-step Runga Kutta method can be selected with the string 'rk'. |
interpolation_method | character(64) | Controls how the expected value of an observation is computed. The default is 'standard' which uses a linear interpolation between the two surrounding model points. Other options include 'square' which returns the square of the computed value, 'opposite_side' which adds on a value from the opposite side of the cyclical domain, and 'average' which averages 15 points to get the expected value. Model size should be > 15 to use the last option. |
types_mod time_manager_mod oned/location_mod utilities_mod
A note about documentation style. Optional arguments are enclosed in brackets [like this].
NOTE: NOT UPDATED YET FOR THE MANHATTAN RELEASE. The details of these interfaces will be generated by Doxygen. For now, see the code.
integer :: get_model_size
Returns the length of the model state vector as an integer. This is fixed at 2 for this model.
model_size | The length of the model state vector. |
real(r8), dimension(:), intent(inout) :: x type(time_type), intent(in) :: time
Advances the model for a single time step. The time associated with the initial model state is also input although it is not used for the computation.
x | State vector of length model_size. |
time | Unused in this model. |
integer, intent(in) :: index_in type(location_type), intent(out) :: location integer, optional, intent(out) :: var_type
Returns the location of the given index, and a dummy integer as the var_type.
index_in | Index of state vector element about which information is requested. |
location | Returns location of indexed state variable, evenly distributed around a periodic unit circle. |
var_type | Returns the type of the indexed state variable as an optional argument. |
real(r8), dimension(:), intent(in) :: x type(location_type), intent(in) :: location integer, intent(in) :: itype real(r8), intent(out) :: obs_val integer, intent(out) :: istatus
A NULL INTERFACE in this model. Always returns istatus = 0.
x | A model state vector. |
location | Location to which to interpolate. |
itype | Integer indexing which type of state variable is to be interpolated. Can be ignored for low order models with a single type of variable. |
obs_val | The interpolated value from the model. |
istatus | Quality control information about the observation of the model state. |
type(time_type) :: get_model_time_step
Returns the models base time step, or forecast length, as a time_type. This is settable in the namelist.
var | Smallest time step of model. |
Reads the namelist, defines the 2 initial locations of the state variables, and sets the timestep.
A NULL INTERFACE in this model.
type(time_type), intent(out) :: time
Returns a time of 0.
time | Initial model time. |
real(r8), dimension(:), intent(out) :: x
Sets 2 initial locations close to the attractor.
x | Initial conditions for state vector. |
integer :: nc_write_model_atts integer, intent(in) :: ncFileID
Uses the default template code.
ncFileID | Integer file descriptor to previously-opened netCDF file. |
ierr | Returns a 0 for successful completion. |
integer :: nc_write_model_vars integer, intent(in) :: ncFileID real(r8), dimension(:), intent(in) :: statevec integer, intent(in) :: copyindex integer, intent(in) :: timeindex
Uses the default template code.
ncFileID | file descriptor to previously-opened netCDF file. |
statevec | A model state vector. |
copyindex | Integer index of copy to be written. |
timeindex | The timestep counter for the given state. |
ierr | Returns 0 for normal completion. |
real(r8), dimension(:), intent(in) :: state real(r8), dimension(:), intent(out) :: pert_state logical, intent(out) :: interf_provided
Given a model state, produces a perturbed model state. This particular model does not implement an interface for this and so returns .false. for interf_provided.
state | State vector to be perturbed. |
pert_state | Perturbed state vector: NOT returned. |
interf_provided | Returned false; interface is not implemented. |
type(get_close_type), intent(inout) :: gc real(r8), intent(in) :: maxdist
Pass-through to the 1-D locations module. See get_close_maxdist_init() for the documentation of this subroutine.
type(get_close_type), intent(inout) :: gc integer, intent(in) :: num type(location_type), intent(in) :: obs(num)
Pass-through to the 1-D locations module. See get_close_obs_init() for the documentation of this subroutine.
type(get_close_type), intent(in) :: gc type(location_type), intent(in) :: base_obs_loc integer, intent(in) :: base_obs_kind type(location_type), intent(in) :: obs(:) integer, intent(in) :: obs_kind(:) integer, intent(out) :: num_close integer, intent(out) :: close_ind(:) real(r8), optional, intent(out) :: dist(:)
Pass-through to the 1-D locations module. See get_close_obs() for the documentation of this subroutine.
real(r8), dimension(:), intent(in) :: ens_mean
A NULL INTERFACE in this model.
ens_mean | State vector containing the ensemble mean. |
filename | purpose |
---|---|
input.nml | to read the model_mod namelist |
preassim.nc | the time-history of the model state before assimilation |
analysis.nc | the time-history of the model state after assimilation |
dart_log.out [default name] | the run-time diagnostic output |
dart_log.nml [default name] | the record of all the namelists actually USED - contains the default values |
Routine | Message | Comment |
---|---|---|
nc_write_model_atts nc_write_model_vars |
Various netCDF-f90 interface error messages | From one of the netCDF calls in the named routine |
none at this time
none at this time
N/A
DART software - Copyright UCAR. This open source software is provided by UCAR, "as is", without charge, subject to all terms of use at http://www.image.ucar.edu/DAReS/DART/DART_download
Contact: | DART core group |
Revision: | $Revision$ |
Source: | $URL$ |
Change Date: | $Date$ |
Change history: | try "svn log" or "svn diff" |