MOM6
Public variables and constants | List of all members
advection_test_tracer::advection_test_tracer_cs Type Reference

Detailed Description

The control structure for the advect_test_tracer module.

Definition at line 37 of file advection_test_tracer.F90.

Collaboration diagram for advection_test_tracer::advection_test_tracer_cs:
[legend]

Public variables and constants

integer ntr = NTR
 Number of tracers in this module. 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 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) land_val = -1.0
 The value of tr used where land is masked out. More...
 
logical use_sponge
 If true, sponges may be applied somewhere in the domain. More...
 
logical tracers_may_reinit
 If true, the tracers may be set up via the initialization code if they are not found in the restart files. Otherwise it is a fatal error if the tracers are not found in the restart files of a restarted run. More...
 
real x_origin
 Parameters describing the test functions. More...
 
real x_width
 Parameters describing the test functions. More...
 
real y_origin
 Parameters describing the test functions. More...
 
real y_width
 Parameters describing the test functions. 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(mom_restart_cs), pointer restart_csp => NULL()
 A pointer to the restart control structure. More...
 
type(vardesc), dimension(ntr) tr_desc
 Descriptions and metadata for the tracers. More...
 

Variables and constants

◆ coupled_tracers

logical advection_test_tracer::advection_test_tracer_cs::coupled_tracers = .false.

These tracers are not offered to the coupler.

Definition at line 39 of file advection_test_tracer.F90.

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

◆ diag

type(diag_ctrl), pointer advection_test_tracer::advection_test_tracer_cs::diag => NULL()

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

Definition at line 57 of file advection_test_tracer.F90.

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

◆ ind_tr

integer, dimension(ntr) advection_test_tracer::advection_test_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 54 of file advection_test_tracer.F90.

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

◆ land_val

real, dimension(ntr) advection_test_tracer::advection_test_tracer_cs::land_val = -1.0

The value of tr used where land is masked out.

Definition at line 44 of file advection_test_tracer.F90.

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

◆ ntr

integer advection_test_tracer::advection_test_tracer_cs::ntr = NTR

Number of tracers in this module.

Definition at line 38 of file advection_test_tracer.F90.

38  integer :: ntr = ntr !< Number of tracers in this module

◆ restart_csp

type(mom_restart_cs), pointer advection_test_tracer::advection_test_tracer_cs::restart_csp => NULL()

A pointer to the restart control structure.

Definition at line 59 of file advection_test_tracer.F90.

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

◆ time

type(time_type), pointer advection_test_tracer::advection_test_tracer_cs::time => NULL()

A pointer to the ocean model's clock.

Definition at line 41 of file advection_test_tracer.F90.

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

◆ tr

real, dimension(:,:,:,:), pointer advection_test_tracer::advection_test_tracer_cs::tr => NULL()

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

Definition at line 43 of file advection_test_tracer.F90.

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

◆ tr_desc

type(vardesc), dimension(ntr) advection_test_tracer::advection_test_tracer_cs::tr_desc

Descriptions and metadata for the tracers.

Definition at line 61 of file advection_test_tracer.F90.

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

◆ tr_reg

type(tracer_registry_type), pointer advection_test_tracer::advection_test_tracer_cs::tr_reg => NULL()

A pointer to the MOM tracer registry.

Definition at line 42 of file advection_test_tracer.F90.

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

◆ tracer_ic_file

character(len=200) advection_test_tracer::advection_test_tracer_cs::tracer_ic_file

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

Definition at line 40 of file advection_test_tracer.F90.

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

◆ tracers_may_reinit

logical advection_test_tracer::advection_test_tracer_cs::tracers_may_reinit

If true, the tracers may be set up via the initialization code if they are not found in the restart files. Otherwise it is a fatal error if the tracers are not found in the restart files of a restarted run.

Definition at line 46 of file advection_test_tracer.F90.

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

◆ use_sponge

logical advection_test_tracer::advection_test_tracer_cs::use_sponge

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

Definition at line 45 of file advection_test_tracer.F90.

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

◆ x_origin

real advection_test_tracer::advection_test_tracer_cs::x_origin

Parameters describing the test functions.

Definition at line 49 of file advection_test_tracer.F90.

49  real :: x_origin !< Parameters describing the test functions

◆ x_width

real advection_test_tracer::advection_test_tracer_cs::x_width

Parameters describing the test functions.

Definition at line 50 of file advection_test_tracer.F90.

50  real :: x_width !< Parameters describing the test functions

◆ y_origin

real advection_test_tracer::advection_test_tracer_cs::y_origin

Parameters describing the test functions.

Definition at line 51 of file advection_test_tracer.F90.

51  real :: y_origin !< Parameters describing the test functions

◆ y_width

real advection_test_tracer::advection_test_tracer_cs::y_width

Parameters describing the test functions.

Definition at line 52 of file advection_test_tracer.F90.

52  real :: y_width !< Parameters describing the test functions
The documentation for this type was generated from the following file: