MOM6
dyed_obc_tracer::dyed_obc_tracer_cs Type Reference

Detailed Description

The control structure for the dyed_obc tracer package.

Definition at line 33 of file dyed_obc_tracer.F90.

Collaboration diagram for dyed_obc_tracer::dyed_obc_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) tracer_ic_file
 The full path to the IC file, or " " to initialize internally. 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 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...
 

Variables and constants

◆ coupled_tracers

logical dyed_obc_tracer::dyed_obc_tracer_cs::coupled_tracers = .false.

These tracers are not offered to the coupler.

Definition at line 35 of file dyed_obc_tracer.F90.

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

◆ diag

type(diag_ctrl), pointer dyed_obc_tracer::dyed_obc_tracer_cs::diag => NULL()

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

Definition at line 44 of file dyed_obc_tracer.F90.

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

◆ ind_tr

integer, dimension(:), allocatable dyed_obc_tracer::dyed_obc_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 41 of file dyed_obc_tracer.F90.

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

◆ ntr

integer dyed_obc_tracer::dyed_obc_tracer_cs::ntr

The number of tracers that are actually used.

Definition at line 34 of file dyed_obc_tracer.F90.

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

◆ restart_csp

type(mom_restart_cs), pointer dyed_obc_tracer::dyed_obc_tracer_cs::restart_csp => NULL()

A pointer to the restart control structure.

Definition at line 46 of file dyed_obc_tracer.F90.

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

◆ time

type(time_type), pointer dyed_obc_tracer::dyed_obc_tracer_cs::time => NULL()

A pointer to the ocean model's clock.

Definition at line 37 of file dyed_obc_tracer.F90.

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

◆ tr

real, dimension(:,:,:,:), pointer dyed_obc_tracer::dyed_obc_tracer_cs::tr => NULL()

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

Definition at line 39 of file dyed_obc_tracer.F90.

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

◆ tr_desc

type(vardesc), dimension(:), allocatable dyed_obc_tracer::dyed_obc_tracer_cs::tr_desc

Descriptions and metadata for the tracers.

Definition at line 48 of file dyed_obc_tracer.F90.

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

◆ tr_reg

type(tracer_registry_type), pointer dyed_obc_tracer::dyed_obc_tracer_cs::tr_reg => NULL()

A pointer to the tracer registry.

Definition at line 38 of file dyed_obc_tracer.F90.

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

◆ tracer_ic_file

character(len=200) dyed_obc_tracer::dyed_obc_tracer_cs::tracer_ic_file

The full path to the IC file, or " " to initialize internally.

Definition at line 36 of file dyed_obc_tracer.F90.

36  character(len=200) :: tracer_IC_file !< The full path to the IC file, or " " to initialize internally.

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