Detailed Description

The control structure for the boundary impulse tracer package.

Definition at line 40 of file boundary_impulse_tracer.F90.

Collaboration diagram for boundary_impulse_tracer::boundary_impulse_tracer_cs:

Public variables and constants
integer	ntr =NTR_MAX
	The number of tracers that are actually used. More...

logical	coupled_tracers = .false.
	These tracers are not offered to the coupler. 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...

logical	tracers_may_reinit
	If true, boundary_impulse can be initialized if not found in restart file. More...

integer, dimension(ntr_max)	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...

integer	nkml
	Number of layers in mixed layer. More...

real, dimension(ntr_max)	land_val = -1.0
	A value to use to fill in tracers over land. More...

real	kw_eff
	An effective piston velocity used to flux tracer out at the surface. More...

real	remaining_source_time
	How much longer (same units as the timestep) to inject the tracer at the surface [s]. 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 retart control structure. More...

type(vardesc), dimension(ntr_max)	tr_desc
	Descriptions and metadata for the tracers. More...

Variables and constants

◆ coupled_tracers

logical boundary_impulse_tracer::boundary_impulse_tracer_cs::coupled_tracers = .false.

These tracers are not offered to the coupler.

Definition at line 42 of file boundary_impulse_tracer.F90.

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

◆ diag

type(diag_ctrl), pointer boundary_impulse_tracer::boundary_impulse_tracer_cs::diag => NULL()

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

Definition at line 56 of file boundary_impulse_tracer.F90.

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

◆ ind_tr

integer, dimension(ntr_max) boundary_impulse_tracer::boundary_impulse_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 47 of file boundary_impulse_tracer.F90.

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

◆ kw_eff

real boundary_impulse_tracer::boundary_impulse_tracer_cs::kw_eff

An effective piston velocity used to flux tracer out at the surface.

Definition at line 52 of file boundary_impulse_tracer.F90.

52 real :: kw_eff !< An effective piston velocity used to flux tracer out at the surface

◆ land_val

real, dimension(ntr_max) boundary_impulse_tracer::boundary_impulse_tracer_cs::land_val = -1.0

A value to use to fill in tracers over land.

Definition at line 51 of file boundary_impulse_tracer.F90.

51 real, dimension(NTR_MAX) :: land_val = -1.0 !< A value to use to fill in tracers over land

◆ nkml

integer boundary_impulse_tracer::boundary_impulse_tracer_cs::nkml

Number of layers in mixed layer.

Definition at line 50 of file boundary_impulse_tracer.F90.

50 integer :: nkml !< Number of layers in mixed layer

◆ ntr

integer boundary_impulse_tracer::boundary_impulse_tracer_cs::ntr =NTR_MAX

The number of tracers that are actually used.

Definition at line 41 of file boundary_impulse_tracer.F90.

41 integer :: ntr=ntr_max !< The number of tracers that are actually used.

◆ remaining_source_time

real boundary_impulse_tracer::boundary_impulse_tracer_cs::remaining_source_time

How much longer (same units as the timestep) to inject the tracer at the surface [s].

Definition at line 53 of file boundary_impulse_tracer.F90.

53 real :: remaining_source_time !< How much longer (same units as the timestep) to

◆ restart_csp

type(mom_restart_cs), pointer boundary_impulse_tracer::boundary_impulse_tracer_cs::restart_csp => NULL()

A pointer to the retart control structure.

Definition at line 58 of file boundary_impulse_tracer.F90.

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

◆ time

type(time_type), pointer boundary_impulse_tracer::boundary_impulse_tracer_cs::time => NULL()

A pointer to the ocean model's clock.

Definition at line 43 of file boundary_impulse_tracer.F90.

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

◆ tr

real, dimension(:,:,:,:), pointer boundary_impulse_tracer::boundary_impulse_tracer_cs::tr => NULL()

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

Definition at line 45 of file boundary_impulse_tracer.F90.

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

◆ tr_desc

type(vardesc), dimension(ntr_max) boundary_impulse_tracer::boundary_impulse_tracer_cs::tr_desc

Descriptions and metadata for the tracers.

Definition at line 60 of file boundary_impulse_tracer.F90.

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

◆ tr_reg

type(tracer_registry_type), pointer boundary_impulse_tracer::boundary_impulse_tracer_cs::tr_reg => NULL()

A pointer to the tracer registry.

Definition at line 44 of file boundary_impulse_tracer.F90.

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

◆ tracers_may_reinit

logical boundary_impulse_tracer::boundary_impulse_tracer_cs::tracers_may_reinit

If true, boundary_impulse can be initialized if not found in restart file.

Definition at line 46 of file boundary_impulse_tracer.F90.

46 logical :: tracers_may_reinit !< If true, boundary_impulse can be initialized if not found in restart file

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

/glade/work/altuntas/cesm.sandboxes/cesm2_2_alpha_X_mom/components/mom/MOM6/src/tracer/boundary_impulse_tracer.F90