mod_input Module Reference

Functions/Subroutines
subroutine	commandlineio (CVS_ID, CVS_Date, CVS_Name, CVS_Revision)
subroutine	name_list_initialize
subroutine	name_list_print
subroutine	name_list_read
subroutine	check_io_dirs
subroutine	nullify_file_pointers
subroutine	incriment_fname (FNAME)
subroutine	open_startup_file
subroutine	open_crashstart
subroutine	search_for_last_matching_name (FNAME)
subroutine	open_coldstart
subroutine	open_new_output
subroutine	open_forcing
subroutine	load_horizontal_mixing_coefficient (NN, CC)
subroutine	load_bottom_roughness (Z0)
subroutine	load_bedflag (BEDFLAG)
subroutine	load_sediment_parameter (t_cd, t_ce, erate)
subroutine	load_grid_type (NCF, G)
subroutine	load_restart_grid (NVG)
subroutine	load_restart_obc_grid (IOBCN_GL, I_OBC_GL, TYPE_OBC_GL)
subroutine	load_restart_lsf_grid (N_GL, I_GL, GEO_GL, WDF_GL)
subroutine	load_restart_coords (X_LCL, Y_LCL)
subroutine	load_restart_depth (H_LCL)
subroutine	load_restart_coriolis (C_LCL)
subroutine	load_restart_sponge (SPG)
subroutine	load_restart_sigma (Z, Z1)
subroutine	load_coldstart_grid (NVG)
subroutine	load_coldstart_obc_grid (IOBCN_GL, I_OBC_GL, TYPE_OBC_GL)
subroutine	load_coldstart_lsf (N_GL, I_GL, GEO_GL, WDF_GL)
subroutine	load_coldstart_coords (X_GBL, Y_GBL, X_LCL, Y_LCL)
subroutine	load_coldstart_depth (X_GBL, Y_GBL, H_LCL)
subroutine	load_coldstart_coriolis (X_GBL, Y_GBL, C_LCL)
subroutine	load_coldstart_sponge (X_GBL, Y_GBL, NSPONGE, N_SPG, R_SPG, C_SPG, X_SPG, Y_SPG)
subroutine	load_coldstart_sigma
subroutine	load_julian_obc (NTC, NAMES, PRD, EQ_AMP, EQ_BETA, EQ_TYPE, MPTD, PHS, RF, TORG)
subroutine	read_julian_obc (JULOBCUNIT_TEMP, NTC, NAMES, PRD, EQ_AMP, EQ_BETA, EQ_TYPE, MPTD, PHS, RF, TORG)
subroutine	parse_tide (line, cnt, ntc, data, ierr)
subroutine	read_coldstart_grid (GRIDUNIT, MGL, NGL, NVG)
subroutine	read_coldstart_obc_grid (OBCUNIT, MGL, IOBCN_GL, I_OBC_GL, TYPE_OBC_GL)
subroutine	read_coldstart_lsf (LSFUNIT, N_GL, I_GL, GEO_GL, WDF_GL)
subroutine	read_coldstart_coords (GRIDUNIT, MGL, XG2, YG2)
subroutine	read_coldstart_depth (DEPTHUNIT, MGL, XG2, YG2, HG2)
subroutine	read_coldstart_coriolis (CORIOLISUNIT, MGL, XG, YG, CORG)
subroutine	read_coldstart_sponge (SPONGEUNIT, MGL, NSPONGE, N_SPG, R_SPG, C_SPG)
subroutine	read_coldstart_sigma
subroutine	helptxt (IPT)

Variables
type(ncfile), pointer	nc_dat
type(ncfile), pointer	nc_avg
type(ncfile), pointer	nc_rst
type(ncfile), pointer	nc_start

Function/Subroutine Documentation

subroutine mod_input::check_io_dirs

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

subroutine mod_input::commandlineio	(	character(len=*), intent(in)	CVS_ID,
		character(len=*), intent(in)	CVS_Date,
		character(len=*), intent(in)	CVS_Name,
		character(len=*), intent(in)	CVS_Revision
	)

Here is the call graph for this function:

Here is the caller graph for this function:

subroutine mod_input::helptxt

(

integer, intent(in)

IPT

)

Here is the caller graph for this function:

subroutine mod_input::incriment_fname

(

character(len=160)

FNAME

)

Here is the call graph for this function:

Here is the caller graph for this function:

subroutine mod_input::load_bedflag

(

real(sp), dimension(:), allocatable

BEDFLAG

)

Here is the caller graph for this function:

subroutine mod_input::load_bottom_roughness

(

real(sp), dimension(:), allocatable

Z0

)

Here is the caller graph for this function:

subroutine mod_input::load_coldstart_coords	(	real(sp), dimension(:), allocatable	X_GBL,
		real(sp), dimension(:), allocatable	Y_GBL,
		real(sp), dimension(:), allocatable	X_LCL,
		real(sp), dimension(:), allocatable	Y_LCL
	)

Here is the call graph for this function:

Here is the caller graph for this function:

subroutine mod_input::load_coldstart_coriolis	(	real(sp), dimension(:), intent(in), allocatable	X_GBL,
		real(sp), dimension(:), intent(in), allocatable	Y_GBL,
		real(sp), dimension(:), allocatable	C_LCL
	)

Here is the call graph for this function:

Here is the caller graph for this function:

subroutine mod_input::load_coldstart_depth	(	real(sp), dimension(:), intent(in), allocatable	X_GBL,
		real(sp), dimension(:), intent(in), allocatable	Y_GBL,
		real(sp), dimension(:), allocatable	H_LCL
	)

Here is the call graph for this function:

Here is the caller graph for this function:

subroutine mod_input::load_coldstart_grid

(

integer, dimension(:,:), intent(out), allocatable

NVG

)

Here is the call graph for this function:

Here is the caller graph for this function:

subroutine mod_input::load_coldstart_lsf	(	integer, intent(out)	N_GL,
		integer, dimension(:), intent(out), allocatable	I_GL,
		real(sp), dimension(:), intent(out), allocatable	GEO_GL,
		real(sp), dimension(:), intent(out), allocatable	WDF_GL
	)

Here is the call graph for this function:

Here is the caller graph for this function:

subroutine mod_input::load_coldstart_obc_grid	(	integer, intent(out)	IOBCN_GL,
		integer, dimension(:), intent(out), allocatable	I_OBC_GL,
		integer, dimension(:), intent(out), allocatable	TYPE_OBC_GL
	)

Here is the call graph for this function:

Here is the caller graph for this function:

subroutine mod_input::load_coldstart_sigma

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

subroutine mod_input::load_coldstart_sponge	(	real(sp), dimension(:), intent(in), allocatable	X_GBL,
		real(sp), dimension(:), intent(in), allocatable	Y_GBL,
		integer, intent(out)	NSPONGE,
		integer, dimension(:), intent(out), allocatable	N_SPG,
		real(sp), dimension(:), intent(out), allocatable	R_SPG,
		real(sp), dimension(:), intent(out), allocatable	C_SPG,
		real(sp), dimension(:), intent(out), allocatable	X_SPG,
		real(sp), dimension(:), intent(out), allocatable	Y_SPG
	)

Here is the call graph for this function:

Here is the caller graph for this function:

subroutine mod_input::load_grid_type	(	type(ncfile), pointer	NCF,
		type(grid), pointer	G
	)

subroutine mod_input::load_horizontal_mixing_coefficient	(	real(sp), dimension(:), allocatable	NN,
		real(sp), dimension(:), allocatable	CC
	)

Here is the caller graph for this function:

subroutine mod_input::load_julian_obc	(	integer, intent(out)	NTC,
		character(len=*), dimension(:), allocatable	NAMES,
		real(sp), dimension(:), intent(out), allocatable	PRD,
		real(sp), dimension(:), intent(out), allocatable	EQ_AMP,
		real(sp), dimension(:), intent(out), allocatable	EQ_BETA,
		character(len=*), dimension(:), allocatable	EQ_TYPE,
		real(sp), dimension(:,:), intent(out), allocatable	MPTD,
		real(sp), dimension(:,:), intent(out), allocatable	PHS,
		real(sp), dimension(:), intent(out), allocatable	RF,
		type(time), intent(out)	TORG
	)

Here is the call graph for this function:

Here is the caller graph for this function:

subroutine mod_input::load_restart_coords	(	real(sp), dimension(:), allocatable, target	X_LCL,
		real(sp), dimension(:), allocatable, target	Y_LCL
	)

Here is the caller graph for this function:

subroutine mod_input::load_restart_coriolis

(

real(sp), dimension(:), allocatable, target

C_LCL

)

Here is the caller graph for this function:

subroutine mod_input::load_restart_depth

(

real(sp), dimension(:), allocatable, target

H_LCL

)

Here is the caller graph for this function:

subroutine mod_input::load_restart_grid

(

integer, dimension(:,:), intent(out), allocatable, target

NVG

)

Here is the caller graph for this function:

subroutine mod_input::load_restart_lsf_grid	(	integer, intent(out)	N_GL,
		integer, dimension(:), intent(out), allocatable, target	I_GL,
		real(sp), dimension(:), intent(out), allocatable, target	GEO_GL,
		real(sp), dimension(:), intent(out), allocatable, target	WDF_GL
	)

Here is the caller graph for this function:

subroutine mod_input::load_restart_obc_grid	(	integer, intent(out)	IOBCN_GL,
		integer, dimension(:), intent(out), allocatable, target	I_OBC_GL,
		integer, dimension(:), intent(out), allocatable, target	TYPE_OBC_GL
	)

Here is the caller graph for this function:

subroutine mod_input::load_restart_sigma	(	real(sp), dimension(:,:), allocatable, target	Z,
		real(sp), dimension(:,:), allocatable, target	Z1
	)

Here is the call graph for this function:

Here is the caller graph for this function:

subroutine mod_input::load_restart_sponge

(

real(sp), dimension(:), allocatable, target

SPG

)

Here is the caller graph for this function:

subroutine mod_input::load_sediment_parameter	(	real(sp), dimension(:), allocatable	t_cd,
		real(sp), dimension(:), allocatable	t_ce,
		real(sp), dimension(:), allocatable	erate
	)

Here is the caller graph for this function:

subroutine mod_input::name_list_initialize

(

)

Here is the caller graph for this function:

subroutine mod_input::name_list_print

(

)

Here is the caller graph for this function:

subroutine mod_input::name_list_read

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

subroutine mod_input::nullify_file_pointers

(

)

Here is the caller graph for this function:

subroutine mod_input::open_coldstart

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

subroutine mod_input::open_crashstart

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

subroutine mod_input::open_forcing

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

subroutine mod_input::open_new_output

(

)

Here is the caller graph for this function:

subroutine mod_input::open_startup_file

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

subroutine mod_input::parse_tide	(	character(len=*)	line,
		integer	cnt,
		integer	ntc,
		real(sp), dimension(:,:), allocatable	data,
		integer	ierr
	)

Here is the call graph for this function:

Here is the caller graph for this function:

subroutine mod_input::read_coldstart_coords	(	integer, intent(in)	GRIDUNIT,
		integer, intent(in)	MGL,
		real(sp), dimension(:), allocatable	XG2,
		real(sp), dimension(:), allocatable	YG2
	)

Here is the caller graph for this function:

subroutine mod_input::read_coldstart_coriolis	(	integer, intent(in)	CORIOLISUNIT,
		integer, intent(in)	MGL,
		real(sp), dimension(:), intent(in), allocatable	XG,
		real(sp), dimension(:), intent(in), allocatable	YG,
		real(sp), dimension(:), allocatable	CORG
	)

Here is the caller graph for this function:

subroutine mod_input::read_coldstart_depth	(	integer, intent(in)	DEPTHUNIT,
		integer, intent(in)	MGL,
		real(sp), dimension(:), intent(in), allocatable	XG2,
		real(sp), dimension(:), intent(in), allocatable	YG2,
		real(sp), dimension(:), allocatable	HG2
	)

Here is the caller graph for this function:

subroutine mod_input::read_coldstart_grid	(	integer, intent(in)	GRIDUNIT,
		integer, intent(out)	MGL,
		integer, intent(out)	NGL,
		integer, dimension(:,:), allocatable	NVG
	)

Here is the caller graph for this function:

subroutine mod_input::read_coldstart_lsf	(	integer, intent(in)	LSFUNIT,
		integer, intent(out)	N_GL,
		integer, dimension(:), intent(out), allocatable	I_GL,
		real(sp), dimension(:), intent(out), allocatable	GEO_GL,
		real(sp), dimension(:), intent(out), allocatable	WDF_GL
	)

Here is the caller graph for this function:

subroutine mod_input::read_coldstart_obc_grid	(	integer, intent(in)	OBCUNIT,
		integer, intent(in)	MGL,
		integer, intent(out)	IOBCN_GL,
		integer, dimension(:), intent(out), allocatable	I_OBC_GL,
		integer, dimension(:), intent(out), allocatable	TYPE_OBC_GL
	)

Here is the caller graph for this function:

subroutine mod_input::read_coldstart_sigma

(

)

Here is the caller graph for this function:

subroutine mod_input::read_coldstart_sponge	(	integer, intent(in)	SPONGEUNIT,
		integer, intent(in)	MGL,
		integer, intent(out)	NSPONGE,
		integer, dimension(:), intent(out), allocatable	N_SPG,
		real(sp), dimension(:), intent(out), allocatable	R_SPG,
		real(sp), dimension(:), intent(out), allocatable	C_SPG
	)

Here is the caller graph for this function:

subroutine mod_input::read_julian_obc	(	integer, intent(in)	JULOBCUNIT_TEMP,
		integer, intent(out)	NTC,
		character(len=*), dimension(:), intent(out), allocatable	NAMES,
		real(sp), dimension(:), intent(out), allocatable	PRD,
		real(sp), dimension(:), intent(out), allocatable	EQ_AMP,
		real(sp), dimension(:), intent(out), allocatable	EQ_BETA,
		character(len=*), dimension(:), intent(out), allocatable	EQ_TYPE,
		real(sp), dimension(:,:), intent(out), allocatable	MPTD,
		real(sp), dimension(:,:), intent(out), allocatable	PHS,
		real(sp), dimension(:), intent(out), allocatable	RF,
		type(time), intent(out)	TORG
	)

Here is the call graph for this function:

Here is the caller graph for this function:

subroutine mod_input::search_for_last_matching_name

(

character(len=160), intent(inout)

FNAME

)

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

type(ncfile), pointer mod_input::nc_avg

type(ncfile), pointer mod_input::nc_dat

type(ncfile), pointer mod_input::nc_rst

type(ncfile), pointer mod_input::nc_start