FV3 Bundle
tracer_manager_mod Module Reference

Data Types

interface  get_tracer_index
 
type  inst_type
 
type  tracer_name_type
 
type  tracer_type
 

Functions/Subroutines

subroutine, public tracer_manager_init
 
subroutine get_tracer_meta_data (model, num_tracers, num_prog, num_diag)
 
integer function model_tracer_number (model, n)
 
subroutine, public register_tracers (model, num_tracers, num_prog, num_diag, num_family)
 
subroutine, public get_number_tracers (model, num_tracers, num_prog, num_diag, num_family)
 
subroutine, public get_tracer_indices (model, ind, prog_ind, diag_ind, fam_ind)
 
integer function get_tracer_index_integer (model, name, indices, verbose)
 
logical function get_tracer_index_logical (model, name, index, indices, verbose)
 
subroutine, public tracer_manager_end
 
subroutine print_tracer_info (model, n)
 
subroutine, public get_tracer_names (model, n, name, longname, units, err_msg)
 
logical function, public get_tracer_name (model, n, name, longname, units, err_msg)
 
logical function, public check_if_prognostic (model, n, err_msg)
 
logical function, public adjust_mass (model, n, err_msg)
 
logical function, public adjust_positive_def (model, n, err_msg)
 
subroutine, public set_tracer_profile (model, n, tracer, err_msg)
 
logical function, public query_method (method_type, model, n, name, control, err_msg)
 
subroutine, public set_tracer_atts (model, name, longname, units)
 
subroutine set_tracer_method (model, name, method_type, method_name, method_control)
 
logical function error_handler (routine, err_msg_local, err_msg)
 

Variables

integer num_tracer_fields = 0
 
integer, parameter, public max_tracer_fields = 150
 
integer, parameter max_tracer_method = 20
 
integer, parameter, public no_tracer = 1-HUGE(1)
 
integer, parameter notracer = -HUGE(1)
 
integer, dimension(num_models) total_tracers
 
integer, dimension(num_models) prog_tracers
 
integer, dimension(num_models) diag_tracers
 
logical, dimension(num_models) model_registered = .FALSE.
 
type(tracer_type), dimension(max_tracer_fields), save tracers
 
type(inst_type), dimension(max_tracer_fields), save instantiations
 
logical module_is_initialized = .false.
 
logical verbose_local
 
integer, dimension(num_models, max_tracer_fieldstracer_array
 

Function/Subroutine Documentation

◆ adjust_mass()

logical function, public tracer_manager_mod::adjust_mass ( integer, intent(in)  model,
integer, intent(in)  n,
character(len=*), intent(out), optional  err_msg 
)

Definition at line 1098 of file tracer_manager.F90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ adjust_positive_def()

logical function, public tracer_manager_mod::adjust_positive_def ( integer, intent(in)  model,
integer, intent(in)  n,
character(len=*), intent(out), optional  err_msg 
)

Definition at line 1122 of file tracer_manager.F90.

Here is the call graph for this function:

◆ check_if_prognostic()

logical function, public tracer_manager_mod::check_if_prognostic ( integer, intent(in)  model,
integer, intent(in)  n,
character(len=*), intent(out), optional  err_msg 
)

Definition at line 1071 of file tracer_manager.F90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ error_handler()

logical function tracer_manager_mod::error_handler ( character(len=*), intent(in)  routine,
character(len=*), intent(in)  err_msg_local,
character(len=*), intent(out), optional  err_msg 
)
private

Definition at line 1573 of file tracer_manager.F90.

Here is the call graph for this function:

◆ get_number_tracers()

subroutine, public tracer_manager_mod::get_number_tracers ( integer, intent(in)  model,
integer, intent(out), optional  num_tracers,
integer, intent(out), optional  num_prog,
integer, intent(out), optional  num_diag,
integer, intent(out), optional  num_family 
)

Definition at line 641 of file tracer_manager.F90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ get_tracer_index_integer()

integer function tracer_manager_mod::get_tracer_index_integer ( integer, intent(in)  model,
character(len=*), intent(in)  name,
integer, dimension(:), intent(in), optional  indices,
logical, intent(in), optional  verbose 
)
private

Definition at line 790 of file tracer_manager.F90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ get_tracer_index_logical()

logical function tracer_manager_mod::get_tracer_index_logical ( integer, intent(in)  model,
character(len=*), intent(in)  name,
integer, intent(out)  index,
integer, dimension(:), intent(in), optional  indices,
logical, intent(in), optional  verbose 
)
private

Definition at line 837 of file tracer_manager.F90.

Here is the call graph for this function:

◆ get_tracer_indices()

subroutine, public tracer_manager_mod::get_tracer_indices ( integer, intent(in)  model,
integer, dimension(:), intent(out), optional  ind,
integer, dimension(:), intent(out), optional  prog_ind,
integer, dimension(:), intent(out), optional  diag_ind,
integer, dimension(:), intent(out), optional  fam_ind 
)

Definition at line 697 of file tracer_manager.F90.

Here is the call graph for this function:

◆ get_tracer_meta_data()

subroutine tracer_manager_mod::get_tracer_meta_data ( integer, intent(in)  model,
integer, intent(out)  num_tracers,
integer, intent(out)  num_prog,
integer, intent(out)  num_diag 
)
private

Definition at line 212 of file tracer_manager.F90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ get_tracer_name()

logical function, public tracer_manager_mod::get_tracer_name ( integer, intent(in)  model,
integer, intent(in)  n,
character (len=*), intent(out)  name,
character (len=*), intent(out), optional  longname,
character (len=*), intent(out), optional  units,
character (len=*), intent(out), optional  err_msg 
)

Definition at line 1014 of file tracer_manager.F90.

Here is the call graph for this function:

◆ get_tracer_names()

subroutine, public tracer_manager_mod::get_tracer_names ( integer, intent(in)  model,
integer, intent(in)  n,
character (len=*), intent(out)  name,
character (len=*), intent(out), optional  longname,
character (len=*), intent(out), optional  units,
character (len=*), intent(out), optional  err_msg 
)

Definition at line 948 of file tracer_manager.F90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ model_tracer_number()

integer function tracer_manager_mod::model_tracer_number ( integer, intent(in)  model,
integer, intent(in)  n 
)
private

Definition at line 558 of file tracer_manager.F90.

Here is the caller graph for this function:

◆ print_tracer_info()

subroutine tracer_manager_mod::print_tracer_info ( integer, intent(in)  model,
integer, intent(in)  n 
)
private

Definition at line 883 of file tracer_manager.F90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ query_method()

logical function, public tracer_manager_mod::query_method ( character(len=*), intent(in)  method_type,
integer, intent(in)  model,
integer, intent(in)  n,
character(len=*), intent(out)  name,
character(len=*), intent(out), optional  control,
character(len=*), intent(out), optional  err_msg 
)

Definition at line 1347 of file tracer_manager.F90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ register_tracers()

subroutine, public tracer_manager_mod::register_tracers ( integer, intent(in)  model,
integer, intent(out)  num_tracers,
integer, intent(out)  num_prog,
integer, intent(out)  num_diag,
integer, intent(out), optional  num_family 
)

Definition at line 603 of file tracer_manager.F90.

Here is the call graph for this function:

◆ set_tracer_atts()

subroutine, public tracer_manager_mod::set_tracer_atts ( integer, intent(in)  model,
character(len=*), intent(in)  name,
character(len=*), intent(in), optional  longname,
character(len=*), intent(in), optional  units 
)

Definition at line 1453 of file tracer_manager.F90.

Here is the call graph for this function:

◆ set_tracer_method()

subroutine tracer_manager_mod::set_tracer_method ( integer, intent(in)  model,
character(len=*), intent(in)  name,
character(len=*), intent(in)  method_type,
character(len=*), intent(in)  method_name,
character(len=*), intent(in)  method_control 
)
private

Definition at line 1527 of file tracer_manager.F90.

Here is the call graph for this function:

◆ set_tracer_profile()

subroutine, public tracer_manager_mod::set_tracer_profile ( integer, intent(in)  model,
integer, intent(in)  n,
real, dimension(:,:,:), intent(inout)  tracer,
character(len=*), intent(out), optional  err_msg 
)

Definition at line 1191 of file tracer_manager.F90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ tracer_manager_end()

subroutine, public tracer_manager_mod::tracer_manager_end ( )

Definition at line 867 of file tracer_manager.F90.

◆ tracer_manager_init()

subroutine, public tracer_manager_mod::tracer_manager_init ( )

Definition at line 190 of file tracer_manager.F90.

Here is the call graph for this function:
Here is the caller graph for this function:

Variable Documentation

◆ diag_tracers

integer, dimension(num_models) tracer_manager_mod::diag_tracers
private

Definition at line 135 of file tracer_manager.F90.

◆ instantiations

type(inst_type), dimension(max_tracer_fields), save tracer_manager_mod::instantiations
private

Definition at line 162 of file tracer_manager.F90.

◆ max_tracer_fields

integer, parameter, public tracer_manager_mod::max_tracer_fields = 150

Definition at line 130 of file tracer_manager.F90.

◆ max_tracer_method

integer, parameter tracer_manager_mod::max_tracer_method = 20
private

Definition at line 131 of file tracer_manager.F90.

◆ model_registered

logical, dimension(num_models) tracer_manager_mod::model_registered = .FALSE.
private

Definition at line 136 of file tracer_manager.F90.

◆ module_is_initialized

logical tracer_manager_mod::module_is_initialized = .false.
private

Definition at line 167 of file tracer_manager.F90.

◆ no_tracer

integer, parameter, public tracer_manager_mod::no_tracer = 1-HUGE(1)

Definition at line 132 of file tracer_manager.F90.

◆ notracer

integer, parameter tracer_manager_mod::notracer = -HUGE(1)
private

Definition at line 133 of file tracer_manager.F90.

◆ num_tracer_fields

integer tracer_manager_mod::num_tracer_fields = 0
private

Definition at line 129 of file tracer_manager.F90.

◆ prog_tracers

integer, dimension(num_models) tracer_manager_mod::prog_tracers
private

Definition at line 135 of file tracer_manager.F90.

◆ total_tracers

integer, dimension(num_models) tracer_manager_mod::total_tracers
private

Definition at line 135 of file tracer_manager.F90.

◆ tracer_array

integer, dimension(num_models,max_tracer_fields) tracer_manager_mod::tracer_array
private

Definition at line 170 of file tracer_manager.F90.

◆ tracers

type(tracer_type), dimension(max_tracer_fields), save tracer_manager_mod::tracers
private

Definition at line 161 of file tracer_manager.F90.

◆ verbose_local

logical tracer_manager_mod::verbose_local
private

Definition at line 169 of file tracer_manager.F90.