program_setup Module Reference

Set up program execution. More...

Functions/Subroutines
subroutine, public	read_setup_namelist (localpet)
	Read program setup namelist. More...

Variables
logical, public	fract_vegsoil_type = .false.
	When true, output the percentage of each soil and vegetation type category, and the dominant category within a model grid box. More...
integer, public	halo = 0
	Number of row/cols defining the lateral boundary halo. More...
character(len=500), public	input_facsf_file = "NULL"
	File containing input fractional coverage data for strong zenith angle dependent albedo. More...
character(len=500), public	input_leaf_area_index_file = "NULL"
	File containing input leaf area index data. More...
character(len=500), public	input_maximum_snow_albedo_file = "NULL"
	File containing input maximum snow albedo data. More...
character(len=500), public	input_slope_type_file = "NULL"
	File containing input slope type data. More...
character(len=500), public	input_snowfree_albedo_file = "NULL"
	File containing input snow-free albedo data. More...
character(len=500), public	input_soil_color_file = "NULL"
	File containing input soil color data. More...
character(len=500), public	input_soil_type_file = "NULL"
	File containing input soil type data. More...
character(len=500), public	input_substrate_temperature_file = "NULL"
	File containing input soil substrate temperature data. More...
character(len=500), public	input_vegetation_greenness_file = "NULL"
	File containing input vegetation greenness data. More...
character(len=500), public	input_vegetation_type_file = "NULL"
	File containing input vegetation type data. More...
character(len=50), public	leaf_area_index_method ='bilinear'
	Interpolation method for leaf area index. More...
character(len=50), public	maximum_snow_albedo_method ='bilinear'
	Interpolation method for max snow albedo. More...
character(len=500), public	mosaic_file_mdl = "NULL"
	Model grid mosaic file. More...
character(len=500), public	orog_dir_mdl = "NULL"
	Directory containing the model grid orography files. More...
character(len=500), dimension(6), public	orog_files_mdl = "NULL"
	Model grid orography filenames. More...
character(len=50), public	snowfree_albedo_method ='bilinear'
	Interpolation method for snowfree albedo. More...
character(len=50), public	vegetation_greenness_method ='bilinear'
	Interpolation method for vegetation greenness. More...

Detailed Description

Set up program execution.

Public variables:

Here 'input' indicates variables associated with the input source data and 'mdl' indicates variables associated with the fv3 model grid.

To not process a surface field, set its 'input_file' variable to NULL. However, vegetation type must always be processed as it defines landice points.

Author

George Gayno

Date

2018

Function/Subroutine Documentation

read_setup_namelist()

subroutine, public program_setup::read_setup_namelist

(

integer, intent(in)

localpet

)

Read program setup namelist.

Parameters

[in]

localpet

mpi task number

Author

George Gayno

Date

2018

Definition at line 64 of file program_setup.f90.

References fract_vegsoil_type, halo, input_facsf_file, input_leaf_area_index_file, input_maximum_snow_albedo_file, input_slope_type_file, input_snowfree_albedo_file, input_soil_color_file, input_soil_type_file, input_substrate_temperature_file, input_vegetation_greenness_file, input_vegetation_type_file, leaf_area_index_method, maximum_snow_albedo_method, mosaic_file_mdl, orog_dir_mdl, orog_files_mdl, snowfree_albedo_method, and vegetation_greenness_method.

Referenced by driver().

Variable Documentation

fract_vegsoil_type

logical, public program_setup::fract_vegsoil_type = .false.

When true, output the percentage of each soil and vegetation type category, and the dominant category within a model grid box.

Definition at line 51 of file program_setup.f90.

Referenced by model_grid::define_model_grid(), driver(), interp(), and read_setup_namelist().

halo

integer, public program_setup::halo = 0

Number of row/cols defining the lateral boundary halo.

Used for regional nests.

Definition at line 48 of file program_setup.f90.

Referenced by output(), output_frac_cats::output_driver(), and read_setup_namelist().

input_facsf_file

character(len=500), public program_setup::input_facsf_file = "NULL"

File containing input fractional coverage data for strong zenith angle dependent albedo.

Definition at line 24 of file program_setup.f90.

Referenced by driver(), and read_setup_namelist().

input_leaf_area_index_file

character(len=500), public program_setup::input_leaf_area_index_file = "NULL"

File containing input leaf area index data.

Definition at line 23 of file program_setup.f90.

Referenced by driver(), and read_setup_namelist().

input_maximum_snow_albedo_file

character(len=500), public program_setup::input_maximum_snow_albedo_file = "NULL"

File containing input maximum snow albedo data.

Definition at line 28 of file program_setup.f90.

Referenced by driver(), and read_setup_namelist().

input_slope_type_file

character(len=500), public program_setup::input_slope_type_file = "NULL"

File containing input slope type data.

Definition at line 30 of file program_setup.f90.

Referenced by driver(), and read_setup_namelist().

input_snowfree_albedo_file

character(len=500), public program_setup::input_snowfree_albedo_file = "NULL"

File containing input snow-free albedo data.

Definition at line 29 of file program_setup.f90.

Referenced by driver(), and read_setup_namelist().

input_soil_color_file

character(len=500), public program_setup::input_soil_color_file = "NULL"

File containing input soil color data.

Definition at line 32 of file program_setup.f90.

Referenced by driver(), and read_setup_namelist().

input_soil_type_file

character(len=500), public program_setup::input_soil_type_file = "NULL"

File containing input soil type data.

Definition at line 31 of file program_setup.f90.

Referenced by driver(), and read_setup_namelist().

input_substrate_temperature_file

character(len=500), public program_setup::input_substrate_temperature_file = "NULL"

File containing input soil substrate temperature data.

Definition at line 27 of file program_setup.f90.

Referenced by driver(), and read_setup_namelist().

input_vegetation_greenness_file

character(len=500), public program_setup::input_vegetation_greenness_file = "NULL"

File containing input vegetation greenness data.

Definition at line 34 of file program_setup.f90.

Referenced by driver(), and read_setup_namelist().

input_vegetation_type_file

character(len=500), public program_setup::input_vegetation_type_file = "NULL"

File containing input vegetation type data.

Definition at line 33 of file program_setup.f90.

Referenced by driver(), and read_setup_namelist().

leaf_area_index_method

character(len=50), public program_setup::leaf_area_index_method ='bilinear'

Interpolation method for leaf area index.

Conservative or bilinear (default).

Definition at line 39 of file program_setup.f90.

Referenced by driver(), and read_setup_namelist().

maximum_snow_albedo_method

character(len=50), public program_setup::maximum_snow_albedo_method ='bilinear'

Interpolation method for max snow albedo.

Conservative or bilinear (default).

Definition at line 41 of file program_setup.f90.

Referenced by driver(), and read_setup_namelist().

mosaic_file_mdl

character(len=500), public program_setup::mosaic_file_mdl = "NULL"

Model grid mosaic file.

Definition at line 35 of file program_setup.f90.

Referenced by model_grid::define_model_grid(), and read_setup_namelist().

orog_dir_mdl

character(len=500), public program_setup::orog_dir_mdl = "NULL"

Directory containing the model grid orography files.

Definition at line 36 of file program_setup.f90.

Referenced by model_grid::define_model_grid(), and read_setup_namelist().

orog_files_mdl

character(len=500), dimension(6), public program_setup::orog_files_mdl = "NULL"

Model grid orography filenames.

Definition at line 37 of file program_setup.f90.

Referenced by model_grid::define_model_grid(), and read_setup_namelist().

snowfree_albedo_method

character(len=50), public program_setup::snowfree_albedo_method ='bilinear'

Interpolation method for snowfree albedo.

Conservative or bilinear (default).

Definition at line 43 of file program_setup.f90.

Referenced by driver(), and read_setup_namelist().

vegetation_greenness_method

character(len=50), public program_setup::vegetation_greenness_method ='bilinear'

Interpolation method for vegetation greenness.

Conservative or bilinear (default).

Definition at line 45 of file program_setup.f90.

Referenced by driver(), and read_setup_namelist().