Detailed Description

The control structure for the regional dyes tracer package.

Definition at line 41 of file dye_example.F90.

Collaboration diagram for regional_dyes::dye_tracer_cs:

Public variables and constants
integer	ntr
	The number of tracers that are actually used. More...

logical	coupled_tracers = .false.
	These tracers are not offered to the coupler. More...

real, dimension(:), allocatable	dye_source_minlon
	Minimum longitude of region dye will be injected. More...

real, dimension(:), allocatable	dye_source_maxlon
	Maximum longitude of region dye will be injected. More...

real, dimension(:), allocatable	dye_source_minlat
	Minimum latitude of region dye will be injected. More...

real, dimension(:), allocatable	dye_source_maxlat
	Maximum latitude of region dye will be injected. More...

real, dimension(:), allocatable	dye_source_mindepth
	Minimum depth of region dye will be injected [Z ~> m]. More...

real, dimension(:), allocatable	dye_source_maxdepth
	Maximum depth of region dye will be injected [Z ~> m]. More...

type(tracer_registry_type), pointer	tr_reg => NULL()
	A pointer to the tracer registry. More...

real, dimension(:,:,:,:), pointer	tr => NULL()
	The array of tracers used in this subroutine, in g m-3? More...

integer, dimension(:), allocatable	ind_tr
	Indices returned by aof_set_coupler_flux if it is used and the surface tracer concentrations are to be provided to the coupler. More...

type(diag_ctrl), pointer	diag => NULL()
	A structure that is used to regulate the timing of diagnostic output. More...

type(mom_restart_cs), pointer	restart_csp => NULL()
	A pointer to the restart control structure. More...

type(vardesc), dimension(:), allocatable	tr_desc
	Descriptions and metadata for the tracers. More...

logical	tracers_may_reinit = .false.
	If true the tracers may be initialized if not found in a restart file. More...

Variables and constants

◆ coupled_tracers

logical regional_dyes::dye_tracer_cs::coupled_tracers = .false.

These tracers are not offered to the coupler.

Definition at line 43 of file dye_example.F90.

43 logical :: coupled_tracers = .false. !< These tracers are not offered to the coupler.

◆ diag

type(diag_ctrl), pointer regional_dyes::dye_tracer_cs::diag => NULL()

A structure that is used to regulate the timing of diagnostic output.

Definition at line 56 of file dye_example.F90.

56 type(diag_ctrl), pointer :: diag => null() !< A structure that is used to

◆ dye_source_maxdepth

real, dimension(:), allocatable regional_dyes::dye_tracer_cs::dye_source_maxdepth

Maximum depth of region dye will be injected [Z ~> m].

Definition at line 49 of file dye_example.F90.

49 real, allocatable, dimension(:) :: dye_source_maxdepth !< Maximum depth of region dye will be injected [Z ~> m].

◆ dye_source_maxlat

real, dimension(:), allocatable regional_dyes::dye_tracer_cs::dye_source_maxlat

Maximum latitude of region dye will be injected.

Definition at line 47 of file dye_example.F90.

47 real, allocatable, dimension(:) :: dye_source_maxlat !< Maximum latitude of region dye will be injected.

◆ dye_source_maxlon

real, dimension(:), allocatable regional_dyes::dye_tracer_cs::dye_source_maxlon

Maximum longitude of region dye will be injected.

Definition at line 45 of file dye_example.F90.

45 real, allocatable, dimension(:) :: dye_source_maxlon !< Maximum longitude of region dye will be injected.

◆ dye_source_mindepth

real, dimension(:), allocatable regional_dyes::dye_tracer_cs::dye_source_mindepth

Minimum depth of region dye will be injected [Z ~> m].

Definition at line 48 of file dye_example.F90.

48 real, allocatable, dimension(:) :: dye_source_mindepth !< Minimum depth of region dye will be injected [Z ~> m].

◆ dye_source_minlat

real, dimension(:), allocatable regional_dyes::dye_tracer_cs::dye_source_minlat

Minimum latitude of region dye will be injected.

Definition at line 46 of file dye_example.F90.

46 real, allocatable, dimension(:) :: dye_source_minlat !< Minimum latitude of region dye will be injected.

◆ dye_source_minlon

real, dimension(:), allocatable regional_dyes::dye_tracer_cs::dye_source_minlon

Minimum longitude of region dye will be injected.

Definition at line 44 of file dye_example.F90.

44 real, allocatable, dimension(:) :: dye_source_minlon !< Minimum longitude of region dye will be injected.

◆ ind_tr

integer, dimension(:), allocatable regional_dyes::dye_tracer_cs::ind_tr

Indices returned by aof_set_coupler_flux if it is used and the surface tracer concentrations are to be provided to the coupler.

Definition at line 53 of file dye_example.F90.

53 integer, allocatable, dimension(:) :: ind_tr !< Indices returned by aof_set_coupler_flux if it is used and the

◆ ntr

integer regional_dyes::dye_tracer_cs::ntr

The number of tracers that are actually used.

Definition at line 42 of file dye_example.F90.

42 integer :: ntr !< The number of tracers that are actually used.

◆ restart_csp

type(mom_restart_cs), pointer regional_dyes::dye_tracer_cs::restart_csp => NULL()

A pointer to the restart control structure.

Definition at line 58 of file dye_example.F90.

58 type(MOM_restart_CS), pointer :: restart_CSp => null() !< A pointer to the restart control structure

◆ tr

real, dimension(:,:,:,:), pointer regional_dyes::dye_tracer_cs::tr => NULL()

The array of tracers used in this subroutine, in g m-3?

Definition at line 51 of file dye_example.F90.

51 real, pointer :: tr(:,:,:,:) => null() !< The array of tracers used in this subroutine, in g m-3?

◆ tr_desc

type(vardesc), dimension(:), allocatable regional_dyes::dye_tracer_cs::tr_desc

Descriptions and metadata for the tracers.

Definition at line 60 of file dye_example.F90.

60 type(vardesc), allocatable :: tr_desc(:) !< Descriptions and metadata for the tracers

◆ tr_reg

type(tracer_registry_type), pointer regional_dyes::dye_tracer_cs::tr_reg => NULL()

A pointer to the tracer registry.

Definition at line 50 of file dye_example.F90.

50 type(tracer_registry_type), pointer :: tr_Reg => null() !< A pointer to the tracer registry

◆ tracers_may_reinit

logical regional_dyes::dye_tracer_cs::tracers_may_reinit = .false.

If true the tracers may be initialized if not found in a restart file.

Definition at line 61 of file dye_example.F90.

61 logical :: tracers_may_reinit = .false. !< If true the tracers may be initialized if not found in a restart file

The documentation for this type was generated from the following file:

/glade/work/altuntas/cesm.sandboxes/cesm2_2_alpha_X_mom/components/mom/MOM6/src/tracer/dye_example.F90