MOM6
rgc_tracer::rgc_tracer_cs Type Reference

Detailed Description

tracer control structure

Definition at line 45 of file RGC_tracer.F90.

Collaboration diagram for rgc_tracer::rgc_tracer_cs:
[legend]

Public variables and constants

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
 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. More...
 
real, dimension(:,:,:,:), pointer tr_aux => NULL()
 The masked tracer concentration. More...
 
real, dimension(ntrland_val = -1.0
 The value of tr used where land is masked out. More...
 
real lenlat
 the latitudinal or y-direction length of the domain. More...
 
real lenlon
 the longitudinal or x-direction length of the domain. More...
 
real csl
 The length of the continental shelf (x dir, km) More...
 
real lensponge
 the length of the sponge layer. More...
 
logical mask_tracers
 If true, tracers are masked out in massless layers. More...
 
logical use_sponge
 If true, sponges may be applied somewhere in the domain. More...
 
type(diag_ctrl), pointer diag
 A structure that is used to regulate the timing of diagnostic output. More...
 
type(vardesc), dimension(ntrtr_desc
 Descriptions and metadata for the tracers. More...
 

Variables and constants

◆ coupled_tracers

logical rgc_tracer::rgc_tracer_cs::coupled_tracers = .false.

These tracers are not offered to the coupler.

Definition at line 46 of file RGC_tracer.F90.

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

◆ csl

real rgc_tracer::rgc_tracer_cs::csl

The length of the continental shelf (x dir, km)

Definition at line 55 of file RGC_tracer.F90.

55  real :: CSL !< The length of the continental shelf (x dir, km)

◆ diag

type(diag_ctrl), pointer rgc_tracer::rgc_tracer_cs::diag

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

Definition at line 59 of file RGC_tracer.F90.

59  type(diag_ctrl), pointer :: diag !< A structure that is used to regulate the timing of diagnostic output.

◆ land_val

real, dimension(ntr) rgc_tracer::rgc_tracer_cs::land_val = -1.0

The value of tr used where land is masked out.

Definition at line 52 of file RGC_tracer.F90.

52  real :: land_val(NTR) = -1.0 !< The value of tr used where land is masked out.

◆ lenlat

real rgc_tracer::rgc_tracer_cs::lenlat

the latitudinal or y-direction length of the domain.

Definition at line 53 of file RGC_tracer.F90.

53  real :: lenlat !< the latitudinal or y-direction length of the domain.

◆ lenlon

real rgc_tracer::rgc_tracer_cs::lenlon

the longitudinal or x-direction length of the domain.

Definition at line 54 of file RGC_tracer.F90.

54  real :: lenlon !< the longitudinal or x-direction length of the domain.

◆ lensponge

real rgc_tracer::rgc_tracer_cs::lensponge

the length of the sponge layer.

Definition at line 56 of file RGC_tracer.F90.

56  real :: lensponge !< the length of the sponge layer.

◆ mask_tracers

logical rgc_tracer::rgc_tracer_cs::mask_tracers

If true, tracers are masked out in massless layers.

Definition at line 57 of file RGC_tracer.F90.

57  logical :: mask_tracers !< If true, tracers are masked out in massless layers.

◆ time

type(time_type), pointer rgc_tracer::rgc_tracer_cs::time

A pointer to the ocean model's clock.

Definition at line 48 of file RGC_tracer.F90.

48  type(time_type), pointer :: Time !< A pointer to the ocean model's clock.

◆ tr

real, dimension(:,:,:,:), pointer rgc_tracer::rgc_tracer_cs::tr => NULL()

The array of tracers used in this package.

Definition at line 50 of file RGC_tracer.F90.

50  real, pointer :: tr(:,:,:,:) => null() !< The array of tracers used in this package.

◆ tr_aux

real, dimension(:,:,:,:), pointer rgc_tracer::rgc_tracer_cs::tr_aux => NULL()

The masked tracer concentration.

Definition at line 51 of file RGC_tracer.F90.

51  real, pointer :: tr_aux(:,:,:,:) => null() !< The masked tracer concentration.

◆ tr_desc

type(vardesc), dimension(ntr) rgc_tracer::rgc_tracer_cs::tr_desc

Descriptions and metadata for the tracers.

Definition at line 60 of file RGC_tracer.F90.

60  type(vardesc) :: tr_desc(NTR) !< Descriptions and metadata for the tracers.

◆ tr_reg

type(tracer_registry_type), pointer rgc_tracer::rgc_tracer_cs::tr_reg => NULL()

A pointer to the tracer registry.

Definition at line 49 of file RGC_tracer.F90.

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

◆ tracer_ic_file

character(len = 200) rgc_tracer::rgc_tracer_cs::tracer_ic_file

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

Definition at line 47 of file RGC_tracer.F90.

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

◆ use_sponge

logical rgc_tracer::rgc_tracer_cs::use_sponge

If true, sponges may be applied somewhere in the domain.

Definition at line 58 of file RGC_tracer.F90.

58  logical :: use_sponge !< If true, sponges may be applied somewhere in the domain.

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