INTERFACE / PUBLIC COMPONENTS / NAMELIST / FILES / REFERENCES / ERRORS / BUGS / PLANS / PRIVATE COMPONENTS

PROGRAM preprocess

Contact: Jeff Anderson
Reviewers:  
Revision: $Revision: 1.1 $
Change Date: $Date: 2005/06/11 14:28:11 $
Change history: see CVS log (cop-out, I know)

OVERVIEW

Program to preprocess the obs_def_mod.F90 to remove code sections that are not needed for the selected observation types. The sections of obs_def_mod.F90 that are optional are delimited by #IFDEF observation_type #ENDIF where observation type is the name of one of the types of observations defined in obs_def_mod.F90. The observation kinds to be assimilated or evaluated are specified by entries in the obs_def_nml which is read by preprocess. Code for ifdef blocks that are not to be assimilated or evaluated are not included in obs_def_mod.f90.




OTHER MODULES USED

types_mod
utilities_mod

Optional namelist interfaces &obs_def_nml and &preprocess_nml may be read from file input.nml.




NAMELIST

We adhere to the F90 standard of starting a namelist with an ampersand '&' and terminating with a slash '/'.

namelist / preprocess_nml/  &
   input_file, output_file

Discussion

This namelist is read in a file called input.nml

Contents Type Description
input_file character(len=129) [default: 'no_default_input_file'] The file to be preprocessed. Normally a relative path_name to obs_def_mod.F90.
output_file character(len=129) [default: 'no_default_input_file'] The file to be created. Normally a relative path_name to obs_def_mod.f90.
namelist / obs_def_nml/  &
   assimilate_these_obs_types, evaluate_these_obs_types

Discussion

This namelist is read in a file called input.nml

Contents Type Description
assimilate_these_obs_types character(len=129), dimension(max_obs_kinds) [default: 'null'] List of observation kinds to be assimilated specified by string name from obs_def_mod.F90.
evaluate_these_obs_types character(len=129), dimension(max_obs_kinds) [default: 'null'] List of observation kinds to be evaluated but not assimilated specified by string name from obs_def_mod.F90.



FILES




REFERENCES


ERROR CODES and CONDITIONS

RoutineMessageComment
preprocess input file 'file name' does not exist. Need an input file to preprocess.
preprocess output file 'file name' exists: MOVE TO AVOID OVERWRITE. Don't want to risk overwriting files.



KNOWN BUGS




FUTURE PLANS