MOM6
Public variables and constants | List of all members
user_tracer_example::user_tracer_example_cs Type Reference

Detailed Description

The control structure for the USER_tracer_example module.

Definition at line 35 of file tracer_example.F90.

Collaboration diagram for user_tracer_example::user_tracer_example_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 => 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...
 
real, dimension(ntr) land_val = -1.0
 The value of tr that is used where land is masked out. More...
 
logical use_sponge
 If true, sponges may be applied somewhere in the domain. More...
 
integer, dimension(ntr) 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(vardesc), dimension(ntr) tr_desc
 Descriptions of each of the tracers. More...
 

Variables and constants

◆ coupled_tracers

logical user_tracer_example::user_tracer_example_cs::coupled_tracers = .false.

These tracers are not offered to the coupler.

Definition at line 36 of file tracer_example.F90.

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

◆ diag

type(diag_ctrl), pointer user_tracer_example::user_tracer_example_cs::diag => NULL()

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

Definition at line 48 of file tracer_example.F90.

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

◆ ind_tr

integer, dimension(ntr) user_tracer_example::user_tracer_example_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 45 of file tracer_example.F90.

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

◆ land_val

real, dimension(ntr) user_tracer_example::user_tracer_example_cs::land_val = -1.0

The value of tr that is used where land is masked out.

Definition at line 42 of file tracer_example.F90.

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

◆ time

type(time_type), pointer user_tracer_example::user_tracer_example_cs::time => NULL()

A pointer to the ocean model's clock.

Definition at line 39 of file tracer_example.F90.

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

◆ tr

real, dimension(:,:,:,:), pointer user_tracer_example::user_tracer_example_cs::tr => NULL()

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

Definition at line 41 of file tracer_example.F90.

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

◆ tr_desc

type(vardesc), dimension(ntr) user_tracer_example::user_tracer_example_cs::tr_desc

Descriptions of each of the tracers.

Definition at line 50 of file tracer_example.F90.

50  type(vardesc) :: tr_desc(NTR) !< Descriptions of each of the tracers.

◆ tr_reg

type(tracer_registry_type), pointer user_tracer_example::user_tracer_example_cs::tr_reg => NULL()

A pointer to the tracer registry.

Definition at line 40 of file tracer_example.F90.

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

◆ tracer_ic_file

character(len=200) user_tracer_example::user_tracer_example_cs::tracer_ic_file

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

Definition at line 37 of file tracer_example.F90.

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

◆ use_sponge

logical user_tracer_example::user_tracer_example_cs::use_sponge

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

Definition at line 43 of file tracer_example.F90.

43  logical :: use_sponge !< If true, sponges may be applied somewhere in the domain.
The documentation for this type was generated from the following file: