MOM6
ideal_age_example::ideal_age_tracer_cs Type Reference

Detailed Description

The control structure for the ideal_age_tracer package.

Definition at line 38 of file ideal_age_example.F90.

Collaboration diagram for ideal_age_example::ideal_age_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...
 
integer nkml
 The number of layers in the mixed layer. The ideal. 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...
 
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 tracer registry. More...
 
real, dimension(:,:,:,:), pointer tr => NULL()
 The array of tracers used in this package, 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_maxtracer_start_year
 The year in which tracers start aging, or at which the surface value equals young_val, in years. More...
 
logical tracers_may_reinit
 If true, these tracers be set up via the initialization code if they are not found in the restart files. More...
 
logical, dimension(ntr_maxtracer_ages
 Indicates whether each tracer ages. 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(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 controls structure. More...
 
type(vardesc), dimension(ntr_maxtr_desc
 Descriptions and metadata for the tracers. More...
 

Variables and constants

◆ coupled_tracers

logical ideal_age_example::ideal_age_tracer_cs::coupled_tracers = .false.

These tracers are not offered to the coupler.

Definition at line 40 of file ideal_age_example.F90.

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

◆ diag

type(diag_ctrl), pointer ideal_age_example::ideal_age_tracer_cs::diag => NULL()

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

Definition at line 62 of file ideal_age_example.F90.

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

◆ ic_file

character(len=200) ideal_age_example::ideal_age_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 43 of file ideal_age_example.F90.

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

◆ ic_val

real, dimension(ntr_max) ideal_age_example::ideal_age_tracer_cs::ic_val = 0.0

The (uniform) initial condition value.

Definition at line 49 of file ideal_age_example.F90.

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

◆ ind_tr

integer, dimension(ntr_max) ideal_age_example::ideal_age_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 59 of file ideal_age_example.F90.

59  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) ideal_age_example::ideal_age_tracer_cs::land_val = -1.0

The value of tr used where land is masked out.

Definition at line 51 of file ideal_age_example.F90.

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

◆ nkml

integer ideal_age_example::ideal_age_tracer_cs::nkml

The number of layers in the mixed layer. The ideal.

Definition at line 41 of file ideal_age_example.F90.

41  integer :: nkml !< The number of layers in the mixed layer. The ideal

◆ ntr

integer ideal_age_example::ideal_age_tracer_cs::ntr

The number of tracers that are actually used.

Definition at line 39 of file ideal_age_example.F90.

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

◆ restart_csp

type(mom_restart_cs), pointer ideal_age_example::ideal_age_tracer_cs::restart_csp => NULL()

A pointer to the restart controls structure.

Definition at line 64 of file ideal_age_example.F90.

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

◆ sfc_growth_rate

real, dimension(ntr_max) ideal_age_example::ideal_age_tracer_cs::sfc_growth_rate

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

Definition at line 52 of file ideal_age_example.F90.

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

◆ time

type(time_type), pointer ideal_age_example::ideal_age_tracer_cs::time => NULL()

A pointer to the ocean model's clock.

Definition at line 46 of file ideal_age_example.F90.

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

◆ tr

real, dimension(:,:,:,:), pointer ideal_age_example::ideal_age_tracer_cs::tr => NULL()

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

Definition at line 48 of file ideal_age_example.F90.

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

◆ tr_desc

type(vardesc), dimension(ntr_max) ideal_age_example::ideal_age_tracer_cs::tr_desc

Descriptions and metadata for the tracers.

Definition at line 66 of file ideal_age_example.F90.

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

◆ tr_reg

type(tracer_registry_type), pointer ideal_age_example::ideal_age_tracer_cs::tr_reg => NULL()

A pointer to the tracer registry.

Definition at line 47 of file ideal_age_example.F90.

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

◆ tracer_ages

logical, dimension(ntr_max) ideal_age_example::ideal_age_tracer_cs::tracer_ages

Indicates whether each tracer ages.

Definition at line 57 of file ideal_age_example.F90.

57  logical :: tracer_ages(NTR_MAX) !< Indicates whether each tracer ages.

◆ tracer_start_year

real, dimension(ntr_max) ideal_age_example::ideal_age_tracer_cs::tracer_start_year

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

Definition at line 53 of file ideal_age_example.F90.

53  real, dimension(NTR_MAX) :: tracer_start_year !< The year in which tracers start aging, or at which the

◆ tracers_may_reinit

logical ideal_age_example::ideal_age_tracer_cs::tracers_may_reinit

If true, these tracers be set up via the initialization code if they are not found in the restart files.

Definition at line 55 of file ideal_age_example.F90.

55  logical :: tracers_may_reinit !< If true, these tracers be set up via the initialization code if

◆ young_val

real, dimension(ntr_max) ideal_age_example::ideal_age_tracer_cs::young_val = 0.0

The value assigned to tr at the surface.

Definition at line 50 of file ideal_age_example.F90.

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

◆ z_ic_file

logical ideal_age_example::ideal_age_tracer_cs::z_ic_file

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

Definition at line 45 of file ideal_age_example.F90.

45  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: