marbl_interface module reference

A non-functioning template of the MARBL interface.

Data Types

marbl_interface_class

A non-functioning template of the MARBL_interface class.

Functions/Subroutines

`put_setting()`	Dummy version of MARBL's `put_setting()` function.
`get_setting()`	Dummy version of MARBL's `get_setting()` function.
`init()`	Dummy version of MARBL's `init()` function.
`compute_totchl()`	Dummy version of MARBL's compute_totChl() function.
`surface_flux_compute()`	Dummy version of MARBL's `surface_flux_compute()` function.
`interior_tendency_compute()`	Dummy version of MARBL's `interior_tendency_compute()` function.
`add_output_for_gcm()`	Dummy version of MARBL's add_output_for_GCM() function.
`shutdown()`	Dummy version of MARBL's `shutdown()` function.

Detailed Description

A non-functioning template of the MARBL interface.

Type Documentation

type marbl_interface/marbl_interface_class

A non-functioning template of the MARBL_interface class.

Type fields:

% statuslog :: type(marbl_log_type) dummy log
% surface_flux_forcings :: type(marbl_forcing_fields_type), dimension(:), allocatable dummy forcing array
% interior_tendency_forcings :: type(marbl_forcing_fields_type), dimension(:), allocatable dummy forcing array
% tracer_metadata :: type(marbl_tracer_metadata_type), dimension(:), allocatable dummy metadata array
% domain :: type(marbl_domain_type) dummy domain
% surface_flux_saved_state :: type(marbl_saved_state_type) dummy saved state
% interior_tendency_saved_state :: type(marbl_saved_state_type) dummy saved state
% surface_flux_diags :: type(marbl_diagnostics_type) dummy diagnostics
% interior_tendency_diags :: type(marbl_diagnostics_type) dummy diagnostics
% surface_flux_output :: type(marbl_output_for_gcm_type) dummy output
% interior_tendency_output :: type(marbl_output_for_gcm_type) dummy output
% tracers :: real, dimension(:,:), allocatable dummy tracer array
% tracers_at_surface :: real, dimension(:,:), allocatable dummy tracer surface array
% bot_flux_to_tend :: real, dimension(:), allocatable dummy array for bot flux to tendency wgts
% surface_fluxes :: real, dimension(:,:), allocatable dummy fluxes
% interior_tendencies :: real, dimension(:,:), allocatable dummy tendencies
% put_setting :: procedure, public dummy put_setting routine
% get_setting :: procedure, public dummy get_setting routine
% init :: procedure, public dummy init routine
% compute_totchl :: procedure, public dummy routine to compute total Chlorophyll
% surface_flux_compute :: procedure, public dummy surface flux routine
% interior_tendency_compute :: procedure, public dummy interior tendency routine
% add_output_for_gcm :: procedure, public dummy add_output_for_GCM routine
% shutdown :: procedure, public dummy shutdown routine

[source]

Function/Subroutine Documentation

subroutine marbl_interface/put_setting(self, str_in)

Dummy version of MARBL’s put_setting() function. function.

Call to:: error_msg mom_error_handler::mom_error

[source]

subroutine marbl_interface/get_setting(self, str_in, log_out)

Dummy version of MARBL’s get_setting() function. function.

Call to:: error_msg mom_error_handler::mom_error

[source]

subroutine marbl_interface/init(self, gcm_num_levels, gcm_num_PAR_subcols, gcm_num_elements_surface_flux, gcm_delta_z, gcm_zw, gcm_zt, unit_system_opt, lgcm_has_global_ops)