MOM6
oil_tracer::oil_tracer_cs Type Reference

Detailed Description

The control structure for the oil tracer package.

Definition at line 38 of file oil_tracer.F90.

Collaboration diagram for oil_tracer::oil_tracer_cs:
[legend]

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...
 
character(len=200) ic_file
 The file in which the age-tracer initial values can be found, or an empty string for internal initialization. More...
 
logical z_ic_file
 If true, the IC_file is in Z-space. The default is false. More...
 
real oil_source_longitude
 Latitude of source location (geographic) More...
 
real oil_source_latitude
 Longitude of source location (geographic) More...
 
integer oil_source_i =-999
 Local i of source location (computational) More...
 
integer oil_source_j =-999
 Local j of source location (computational) More...
 
real oil_source_rate
 Rate of oil injection [kg T-1 ~> kg s-1]. More...
 
real oil_start_year
 The year in which tracers start aging, or at which the surface value equals young_val, in years. More...
 
real oil_end_year
 The year in which tracers start aging, or at which the surface value equals young_val, in years. More...
 
type(time_type), pointer time => NULL()
 A pointer to the ocean model's clock. More...
 
type(tracer_registry_type), pointer tr_reg => NULL()
 A pointer to the MOM tracer registry. More...
 
real, dimension(:,:,:,:), pointer tr => NULL()
 The array of tracers used in this subroutine, in g m-3? More...
 
real, dimension(ntr_maxic_val = 0.0
 The (uniform) initial condition value. More...
 
real, dimension(ntr_maxyoung_val = 0.0
 The value assigned to tr at the surface. More...
 
real, dimension(ntr_maxland_val = -1.0
 The value of tr used where land is masked out. More...
 
real, dimension(ntr_maxsfc_growth_rate
 The exponential growth rate for the surface value [year-1]. More...
 
real, dimension(ntr_maxoil_decay_days
 Decay time scale of oil [days]. More...
 
real, dimension(ntr_maxoil_decay_rate
 Decay rate of oil [T-1 ~> s-1] calculated from oil_decay_days. More...
 
integer, dimension(ntr_maxoil_source_k
 Layer of source. More...
 
logical oil_may_reinit
 If true, oil tracers may be reset by the initialization code if they are not found in the restart files. More...
 
integer, dimension(ntr_maxind_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(vardesc), dimension(ntr_maxtr_desc
 Descriptions and metadata for the tracers. 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...
 

Variables and constants

◆ coupled_tracers

logical oil_tracer::oil_tracer_cs::coupled_tracers = .false.

These tracers are not offered to the coupler.

Definition at line 40 of file oil_tracer.F90.

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

◆ diag

type(diag_ctrl), pointer oil_tracer::oil_tracer_cs::diag => NULL()

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

Definition at line 69 of file oil_tracer.F90.

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

◆ ic_file

character(len=200) oil_tracer::oil_tracer_cs::ic_file

The file in which the age-tracer initial values can be found, or an empty string for internal initialization.

Definition at line 41 of file oil_tracer.F90.

41  character(len=200) :: IC_file !< The file in which the age-tracer initial values

◆ ic_val

real, dimension(ntr_max) oil_tracer::oil_tracer_cs::ic_val = 0.0

The (uniform) initial condition value.

Definition at line 56 of file oil_tracer.F90.

56  real, dimension(NTR_MAX) :: IC_val = 0.0 !< The (uniform) initial condition value.

◆ ind_tr

integer, dimension(ntr_max) oil_tracer::oil_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 65 of file oil_tracer.F90.

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

◆ land_val

real, dimension(ntr_max) oil_tracer::oil_tracer_cs::land_val = -1.0

The value of tr used where land is masked out.

Definition at line 58 of file oil_tracer.F90.

58  real, dimension(NTR_MAX) :: land_val = -1.0 !< The value of tr used where land is masked out.

◆ ntr

integer oil_tracer::oil_tracer_cs::ntr

The number of tracers that are actually used.

Definition at line 39 of file oil_tracer.F90.

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

◆ oil_decay_days

real, dimension(ntr_max) oil_tracer::oil_tracer_cs::oil_decay_days

Decay time scale of oil [days].

Definition at line 60 of file oil_tracer.F90.

60  real, dimension(NTR_MAX) :: oil_decay_days !< Decay time scale of oil [days]

◆ oil_decay_rate

real, dimension(ntr_max) oil_tracer::oil_tracer_cs::oil_decay_rate

Decay rate of oil [T-1 ~> s-1] calculated from oil_decay_days.

Definition at line 61 of file oil_tracer.F90.

61  real, dimension(NTR_MAX) :: oil_decay_rate !< Decay rate of oil [T-1 ~> s-1] calculated from oil_decay_days

◆ oil_end_year

real oil_tracer::oil_tracer_cs::oil_end_year

The year in which tracers start aging, or at which the surface value equals young_val, in years.

Definition at line 51 of file oil_tracer.F90.

51  real :: oil_end_year !< The year in which tracers start aging, or at which the

◆ oil_may_reinit

logical oil_tracer::oil_tracer_cs::oil_may_reinit

If true, oil tracers may be reset by the initialization code if they are not found in the restart files.

Definition at line 63 of file oil_tracer.F90.

63  logical :: oil_may_reinit !< If true, oil tracers may be reset by the initialization code

◆ oil_source_i

integer oil_tracer::oil_tracer_cs::oil_source_i =-999

Local i of source location (computational)

Definition at line 46 of file oil_tracer.F90.

46  integer :: oil_source_i=-999 !< Local i of source location (computational)

◆ oil_source_j

integer oil_tracer::oil_tracer_cs::oil_source_j =-999

Local j of source location (computational)

Definition at line 47 of file oil_tracer.F90.

47  integer :: oil_source_j=-999 !< Local j of source location (computational)

◆ oil_source_k

integer, dimension(ntr_max) oil_tracer::oil_tracer_cs::oil_source_k

Layer of source.

Definition at line 62 of file oil_tracer.F90.

62  integer, dimension(NTR_MAX) :: oil_source_k !< Layer of source

◆ oil_source_latitude

real oil_tracer::oil_tracer_cs::oil_source_latitude

Longitude of source location (geographic)

Definition at line 45 of file oil_tracer.F90.

45  real :: oil_source_latitude !< Longitude of source location (geographic)

◆ oil_source_longitude

real oil_tracer::oil_tracer_cs::oil_source_longitude

Latitude of source location (geographic)

Definition at line 44 of file oil_tracer.F90.

44  real :: oil_source_longitude !< Latitude of source location (geographic)

◆ oil_source_rate

real oil_tracer::oil_tracer_cs::oil_source_rate

Rate of oil injection [kg T-1 ~> kg s-1].

Definition at line 48 of file oil_tracer.F90.

48  real :: oil_source_rate !< Rate of oil injection [kg T-1 ~> kg s-1]

◆ oil_start_year

real oil_tracer::oil_tracer_cs::oil_start_year

The year in which tracers start aging, or at which the surface value equals young_val, in years.

Definition at line 49 of file oil_tracer.F90.

49  real :: oil_start_year !< The year in which tracers start aging, or at which the

◆ restart_csp

type(mom_restart_cs), pointer oil_tracer::oil_tracer_cs::restart_csp => NULL()

A pointer to the restart control structure.

Definition at line 71 of file oil_tracer.F90.

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

◆ sfc_growth_rate

real, dimension(ntr_max) oil_tracer::oil_tracer_cs::sfc_growth_rate

The exponential growth rate for the surface value [year-1].

Definition at line 59 of file oil_tracer.F90.

59  real, dimension(NTR_MAX) :: sfc_growth_rate !< The exponential growth rate for the surface value [year-1].

◆ time

type(time_type), pointer oil_tracer::oil_tracer_cs::time => NULL()

A pointer to the ocean model's clock.

Definition at line 53 of file oil_tracer.F90.

53  type(time_type), pointer :: Time => null() !< A pointer to the ocean model's clock.

◆ tr

real, dimension(:,:,:,:), pointer oil_tracer::oil_tracer_cs::tr => NULL()

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

Definition at line 55 of file oil_tracer.F90.

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

◆ tr_desc

type(vardesc), dimension(ntr_max) oil_tracer::oil_tracer_cs::tr_desc

Descriptions and metadata for the tracers.

Definition at line 67 of file oil_tracer.F90.

67  type(vardesc) :: tr_desc(NTR_MAX) !< Descriptions and metadata for the tracers

◆ tr_reg

type(tracer_registry_type), pointer oil_tracer::oil_tracer_cs::tr_reg => NULL()

A pointer to the MOM tracer registry.

Definition at line 54 of file oil_tracer.F90.

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

◆ young_val

real, dimension(ntr_max) oil_tracer::oil_tracer_cs::young_val = 0.0

The value assigned to tr at the surface.

Definition at line 57 of file oil_tracer.F90.

57  real, dimension(NTR_MAX) :: young_val = 0.0 !< The value assigned to tr at the surface.

◆ z_ic_file

logical oil_tracer::oil_tracer_cs::z_ic_file

If true, the IC_file is in Z-space. The default is false.

Definition at line 43 of file oil_tracer.F90.

43  logical :: Z_IC_file !< If true, the IC_file is in Z-space. The default is false.

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